offersapi.md

fiken › OffersApi

Class: OffersApi

Hierarchy

• BaseAPI

  ↳ OffersApi

Index

Constructors

• constructor

Properties

• configuration

Methods

• addAttachmentToOfferDraft
• addAttachmentToOfferDraftRaw
• createOfferDraft
• createOfferDraftRaw
• createOfferFromDraft
• createOfferFromDraftRaw
• deleteOfferDraft
• deleteOfferDraftRaw
• getOffer
• getOfferDraft
• getOfferDraftAttachments
• getOfferDraftAttachmentsRaw
• getOfferDraftRaw
• getOfferDrafts
• getOfferDraftsRaw
• getOfferRaw
• getOffers
• getOffersRaw
• request
• updateOfferDraft
• updateOfferDraftRaw
• withMiddleware
• withPostMiddleware
• withPreMiddleware

Constructors

constructor

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

Inherited from BaseAPI.constructor

Parameters:

Name	Type	Default
configuration	Configuration‹›	new Configuration()

Returns: OffersApi

Properties

Protected configuration

• configuration: Configuration‹›

Inherited from BaseAPI.configuration

Methods

addAttachmentToOfferDraft

▸ addAttachmentToOfferDraft(requestParameters: AddAttachmentToOfferDraftRequest): Promise‹void›

Creates and adds a new attachment to an offer draft

Parameters:

Name	Type
requestParameters	AddAttachmentToOfferDraftRequest

Returns: Promise‹void›

---

addAttachmentToOfferDraftRaw

▸ addAttachmentToOfferDraftRaw(requestParameters: AddAttachmentToOfferDraftRequest): Promise‹ApiResponse‹void››

Creates and adds a new attachment to an offer draft

Parameters:

Name	Type
requestParameters	AddAttachmentToOfferDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createOfferDraft

▸ createOfferDraft(requestParameters: CreateOfferDraftRequest): Promise‹void›

Creates an offer draft.

Parameters:

Name	Type
requestParameters	CreateOfferDraftRequest

Returns: Promise‹void›

---

createOfferDraftRaw

▸ createOfferDraftRaw(requestParameters: CreateOfferDraftRequest): Promise‹ApiResponse‹void››

Creates an offer draft.

Parameters:

Name	Type
requestParameters	CreateOfferDraftRequest

Returns: Promise‹ApiResponse‹void››

---

createOfferFromDraft

▸ createOfferFromDraft(requestParameters: CreateOfferFromDraftRequest): Promise‹void›

Creates an offer from an already created draft.

Parameters:

Name	Type
requestParameters	CreateOfferFromDraftRequest

Returns: Promise‹void›

---

createOfferFromDraftRaw

▸ createOfferFromDraftRaw(requestParameters: CreateOfferFromDraftRequest): Promise‹ApiResponse‹void››

Creates an offer from an already created draft.

Parameters:

Name	Type
requestParameters	CreateOfferFromDraftRequest

Returns: Promise‹ApiResponse‹void››

---

deleteOfferDraft

▸ deleteOfferDraft(requestParameters: DeleteOfferDraftRequest): Promise‹void›

Delete offer draft with specified id.

Parameters:

Name	Type
requestParameters	DeleteOfferDraftRequest

Returns: Promise‹void›

---

deleteOfferDraftRaw

▸ deleteOfferDraftRaw(requestParameters: DeleteOfferDraftRequest): Promise‹ApiResponse‹void››

Delete offer draft with specified id.

Parameters:

Name	Type
requestParameters	DeleteOfferDraftRequest

Returns: Promise‹ApiResponse‹void››

---

getOffer

▸ getOffer(requestParameters: GetOfferRequest): Promise‹Offer›

Returns offer with specified id.

Parameters:

Name	Type
requestParameters	GetOfferRequest

Returns: Promise‹Offer›

---

getOfferDraft

▸ getOfferDraft(requestParameters: GetOfferDraftRequest): Promise‹InvoiceishDraftResult›

Returns offer draft with specified id.

Parameters:

Name	Type
requestParameters	GetOfferDraftRequest

Returns: Promise‹InvoiceishDraftResult›

---

getOfferDraftAttachments

▸ getOfferDraftAttachments(requestParameters: GetOfferDraftAttachmentsRequest): Promise‹Array‹Attachment››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetOfferDraftAttachmentsRequest

Returns: Promise‹Array‹Attachment››

---

getOfferDraftAttachmentsRaw

▸ getOfferDraftAttachmentsRaw(requestParameters: GetOfferDraftAttachmentsRequest): Promise‹ApiResponse‹Array‹Attachment›››

Returns all attachments for specified draft.

Parameters:

Name	Type
requestParameters	GetOfferDraftAttachmentsRequest

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

---

getOfferDraftRaw

▸ getOfferDraftRaw(requestParameters: GetOfferDraftRequest): Promise‹ApiResponse‹InvoiceishDraftResult››

Returns offer draft with specified id.

Parameters:

Name	Type
requestParameters	GetOfferDraftRequest

Returns: Promise‹ApiResponse‹InvoiceishDraftResult››

---

getOfferDrafts

▸ getOfferDrafts(requestParameters: GetOfferDraftsRequest): Promise‹Array‹InvoiceishDraftResult››

Returns all offer drafts for given company.

Parameters:

Name	Type
requestParameters	GetOfferDraftsRequest

Returns: Promise‹Array‹InvoiceishDraftResult››

---

getOfferDraftsRaw

▸ getOfferDraftsRaw(requestParameters: GetOfferDraftsRequest): Promise‹ApiResponse‹Array‹InvoiceishDraftResult›››

Returns all offer drafts for given company.

Parameters:

Name	Type
requestParameters	GetOfferDraftsRequest

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

---

getOfferRaw

▸ getOfferRaw(requestParameters: GetOfferRequest): Promise‹ApiResponse‹Offer››

Returns offer with specified id.

Parameters:

Name	Type
requestParameters	GetOfferRequest

Returns: Promise‹ApiResponse‹Offer››

---

getOffers

▸ getOffers(requestParameters: GetOffersRequest): Promise‹Array‹Offer››

Returns all offers for given company

Parameters:

Name	Type
requestParameters	GetOffersRequest

Returns: Promise‹Array‹Offer››

---

getOffersRaw

▸ getOffersRaw(requestParameters: GetOffersRequest): Promise‹ApiResponse‹Array‹Offer›››

Returns all offers for given company

Parameters:

Name	Type
requestParameters	GetOffersRequest

Returns: Promise‹ApiResponse‹Array‹Offer›››

---

Protected request

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

Inherited from BaseAPI.request

Parameters:

Name	Type
context	RequestOpts

Returns: Promise‹Response›

---

updateOfferDraft

▸ updateOfferDraft(requestParameters: UpdateOfferDraftRequest): Promise‹void›

Updates offer draft with provided id.

Parameters:

Name	Type
requestParameters	UpdateOfferDraftRequest

Returns: Promise‹void›

---

updateOfferDraftRaw

▸ updateOfferDraftRaw(requestParameters: UpdateOfferDraftRequest): Promise‹ApiResponse‹void››

Updates offer draft with provided id.

Parameters:

Name	Type
requestParameters	UpdateOfferDraftRequest

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