orderconfirmationsapi.md

fiken › OrderConfirmationsApi

Class: OrderConfirmationsApi

Hierarchy

• BaseAPI

  ↳ OrderConfirmationsApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• addAttachmentToOrderConfirmationDraft
• addAttachmentToOrderConfirmationDraftRaw
• createOrderConfirmationDraft
• createOrderConfirmationDraftRaw
• createOrderConfirmationFromDraft
• createOrderConfirmationFromDraftRaw
• deleteOrderConfirmationDraft
• deleteOrderConfirmationDraftRaw
• getOrderConfirmation
• getOrderConfirmationDraft
• getOrderConfirmationDraftAttachments
• getOrderConfirmationDraftAttachmentsRaw
• getOrderConfirmationDraftRaw
• getOrderConfirmationDrafts
• getOrderConfirmationDraftsRaw
• getOrderConfirmationRaw
• getOrderConfirmations
• getOrderConfirmationsRaw
• request
• updateOrderConfirmationDraft
• updateOrderConfirmationDraftRaw
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

+ new OrderConfirmationsApi(configuration: Configuration‹›): OrderConfirmationsApi

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: OrderConfirmationsApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

addAttachmentToOrderConfirmationDraft

▸ addAttachmentToOrderConfirmationDraft(requestParameters: AddAttachmentToOrderConfirmationDraftRequest): Promise‹void›

Creates and adds a new attachment to an order confirmation draft

Parameters:

Name	Type
requestParameters	AddAttachmentToOrderConfirmationDraftRequest

Returns: Promise‹void›

---

addAttachmentToOrderConfirmationDraftRaw

▸ addAttachmentToOrderConfirmationDraftRaw(requestParameters: AddAttachmentToOrderConfirmationDraftRequest): Promise‹ApiResponse‹void››

Creates and adds a new attachment to an order confirmation draft

Parameters:

Name	Type
requestParameters	AddAttachmentToOrderConfirmationDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createOrderConfirmationDraft

▸ createOrderConfirmationDraft(requestParameters: CreateOrderConfirmationDraftRequest): Promise‹void›

Creates an order confirmation draft.

Parameters:

Name	Type
requestParameters	CreateOrderConfirmationDraftRequest

Returns: Promise‹void›

---

createOrderConfirmationDraftRaw

▸ createOrderConfirmationDraftRaw(requestParameters: CreateOrderConfirmationDraftRequest): Promise‹ApiResponse‹void››

Creates an order confirmation draft.

Parameters:

Name	Type
requestParameters	CreateOrderConfirmationDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createOrderConfirmationFromDraft

▸ createOrderConfirmationFromDraft(requestParameters: CreateOrderConfirmationFromDraftRequest): Promise‹void›

Creates an order confirmation from an already created draft.

Parameters:

Name	Type
requestParameters	CreateOrderConfirmationFromDraftRequest

Returns: Promise‹void›

---

createOrderConfirmationFromDraftRaw

▸ createOrderConfirmationFromDraftRaw(requestParameters: CreateOrderConfirmationFromDraftRequest): Promise‹ApiResponse‹void››

Creates an order confirmation from an already created draft.

Parameters:

Name	Type
requestParameters	CreateOrderConfirmationFromDraftRequest

Returns: Promise‹ApiResponse‹void››

---

deleteOrderConfirmationDraft

▸ deleteOrderConfirmationDraft(requestParameters: DeleteOrderConfirmationDraftRequest): Promise‹void›

Delete order confirmation draft with specified id.

Parameters:

Name	Type
requestParameters	DeleteOrderConfirmationDraftRequest

Returns: Promise‹void›

---

deleteOrderConfirmationDraftRaw

▸ deleteOrderConfirmationDraftRaw(requestParameters: DeleteOrderConfirmationDraftRequest): Promise‹ApiResponse‹void››

Delete order confirmation draft with specified id.

Parameters:

Name	Type
requestParameters	DeleteOrderConfirmationDraftRequest

Returns: Promise‹ApiResponse‹void››

---

getOrderConfirmation

▸ getOrderConfirmation(requestParameters: GetOrderConfirmationRequest): Promise‹OrderConfirmation›

Returns order confirmation with specified id.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationRequest

Returns: Promise‹OrderConfirmation›

---

getOrderConfirmationDraft

▸ getOrderConfirmationDraft(requestParameters: GetOrderConfirmationDraftRequest): Promise‹InvoiceishDraftResult›

Returns order confirmation draft with specified id.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationDraftRequest

Returns: Promise‹InvoiceishDraftResult›

---

getOrderConfirmationDraftAttachments

▸ getOrderConfirmationDraftAttachments(requestParameters: GetOrderConfirmationDraftAttachmentsRequest): Promise‹Array‹Attachment››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationDraftAttachmentsRequest

Returns: Promise‹Array‹Attachment››

---

getOrderConfirmationDraftAttachmentsRaw

▸ getOrderConfirmationDraftAttachmentsRaw(requestParameters: GetOrderConfirmationDraftAttachmentsRequest): Promise‹ApiResponse‹Array‹Attachment›››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationDraftAttachmentsRequest

Returns: Promise‹ApiResponse‹Array‹Attachment›››

---

getOrderConfirmationDraftRaw

▸ getOrderConfirmationDraftRaw(requestParameters: GetOrderConfirmationDraftRequest): Promise‹ApiResponse‹InvoiceishDraftResult››

Returns order confirmation draft with specified id.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationDraftRequest

Returns: Promise‹ApiResponse‹InvoiceishDraftResult››

---

getOrderConfirmationDrafts

▸ getOrderConfirmationDrafts(requestParameters: GetOrderConfirmationDraftsRequest): Promise‹Array‹InvoiceishDraftResult››

Returns all order confirmation drafts for given company.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationDraftsRequest

Returns: Promise‹Array‹InvoiceishDraftResult››

---

getOrderConfirmationDraftsRaw

▸ getOrderConfirmationDraftsRaw(requestParameters: GetOrderConfirmationDraftsRequest): Promise‹ApiResponse‹Array‹InvoiceishDraftResult›››

Returns all order confirmation drafts for given company.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationDraftsRequest

Returns: Promise‹ApiResponse‹Array‹InvoiceishDraftResult›››

---

getOrderConfirmationRaw

▸ getOrderConfirmationRaw(requestParameters: GetOrderConfirmationRequest): Promise‹ApiResponse‹OrderConfirmation››

Returns order confirmation with specified id.

Parameters:

Name	Type
requestParameters	GetOrderConfirmationRequest

Returns: Promise‹ApiResponse‹OrderConfirmation››

---

getOrderConfirmations

▸ getOrderConfirmations(requestParameters: GetOrderConfirmationsRequest): Promise‹Array‹OrderConfirmation››

Returns all order confirmations for given company

Parameters:

Name	Type
requestParameters	GetOrderConfirmationsRequest

Returns: Promise‹Array‹OrderConfirmation››

---

getOrderConfirmationsRaw

▸ getOrderConfirmationsRaw(requestParameters: GetOrderConfirmationsRequest): Promise‹ApiResponse‹Array‹OrderConfirmation›››

Returns all order confirmations for given company

Parameters:

Name	Type
requestParameters	GetOrderConfirmationsRequest

Returns: Promise‹ApiResponse‹Array‹OrderConfirmation›››

---

Protected request

▸ request(context: RequestOpts): Promise‹Response›

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

updateOrderConfirmationDraft

▸ updateOrderConfirmationDraft(requestParameters: UpdateOrderConfirmationDraftRequest): Promise‹void›

Updates order confirmation draft with provided id.

Parameters:

Name	Type
requestParameters	UpdateOrderConfirmationDraftRequest

Returns: Promise‹void›

---

updateOrderConfirmationDraftRaw

▸ updateOrderConfirmationDraftRaw(requestParameters: UpdateOrderConfirmationDraftRequest): Promise‹ApiResponse‹void››

Updates order confirmation draft with provided id.

Parameters:

Name	Type
requestParameters	UpdateOrderConfirmationDraftRequest

Returns: Promise‹ApiResponse‹void››

---

withMiddleware

▸ withMiddleware‹T›(this: T, ...middlewares: Middleware[]): T

Inherited from BaseAPI.withMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...middlewares	Middleware[]

Returns: T

---

withPostMiddleware

▸ withPostMiddleware‹T›(this: T, ...postMiddlewares: Array‹Middleware["post"]›): T

Inherited from BaseAPI.withPostMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...postMiddlewares	Array‹Middleware["post"]›

Returns: T

---

withPreMiddleware

▸ withPreMiddleware‹T›(this: T, ...preMiddlewares: Array‹Middleware["pre"]›): T

Inherited from BaseAPI.withPreMiddleware

Type parameters:

▪ T: BaseAPI

Parameters:

Name	Type
this	T
...preMiddlewares	Array‹Middleware["pre"]›

Returns: T