feat(model): add Contract

package.json

@@ -1,6 +1,6 @@
 {
   "name": "moysklad-api-model",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "description": "Объектная модель API МойСклад для TypeScript проектов",
   "main": "build/src/index.js",
   "types": "build/src/index.d.ts",

src/model/Contract.ts

@@ -0,0 +1,103 @@
+import type { Entity } from '.'
+import type { Attribute, AttributePatch } from './Attribute'
+import type { EntityRef } from './EntityRef'
+import type { Owned, OwnedPatch } from './Owned'
+import type { Rate } from './Rate'
+
+type ContractTypeFileds =
+  | {
+      /**
+       * Тип Договора.
+       *
+       * Возможные значения:
+       * - Договор комиссии
+       * - Договор купли-продажи
+       */
+      contractType: 'Sales'
+    }
+  | {
+      contractType: 'Commission'
+
+      /**
+       * Тип Вознаграждения.
+       *
+       * Указывается когда `contractType` = `Commission`
+       *
+       * Возможные значения:
+       * - Процент от суммы продажи
+       * - Не рассчитывать
+       * */
+      rewardType: 'None'
+    }
+  | {
+      contractType: 'Commission'
+
+      /**
+       * Тип Вознаграждения.
+       *
+       * Указывается когда `contractType` = `Commission`
+       *
+       * Возможные значения:
+       * - Процент от суммы продажи
+       * - Не рассчитывать
+       * */
+      rewardType: 'PercentOfSales'
+
+      /** Вознаграждение в процентах (от 0 до 100) */
+      rewardPercent: number
+    }
+
+type ContractFields = ContractTypeFileds & {
+  readonly updated: string
+
+  name: string
+
+  description?: string
+
+  code?: string
+
+  externalCode?: string
+
+  archived: boolean
+
+  moment: string
+
+  /** Сумма Договора */
+  sum: number
+
+  ownAgent: EntityRef<'organization'>
+
+  agent: EntityRef<'counterparty' | 'organization'>
+
+  state?: EntityRef<'state'>
+
+  organizationAccount: EntityRef<'account'>
+
+  agentAccount?: EntityRef<'account'>
+
+  rate: Rate
+
+  attributes: Attribute[]
+}
+
+export type Contract = Entity<'contract'> & Owned & ContractFields
+
+export type ContractPatch = Partial<
+  Pick<
+    ContractFields,
+    | 'name'
+    | 'description'
+    | 'code'
+    | 'externalCode'
+    | 'archived'
+    | 'ownAgent'
+    | 'agent'
+    | 'state'
+    | 'organizationAccount'
+    | 'agentAccount'
+    | 'rate'
+  > &
+    ContractTypeFileds
+> & {
+  attributes?: AttributePatch[]
+} & OwnedPatch

src/model/MetaType.ts

@@ -5,6 +5,7 @@ import type {
   CashIn,
   CashOut,
   ContactPerson,
+  Contract,
   Counterparty,
   CustomerOrder,
   CustomerOrderPosition,
@@ -140,7 +141,7 @@ export type EntityByMetaType = {
   companysettings: Entity<'companysettings'>
   consignment: Entity<'consignment'>
   contactperson: ContactPerson
-  contract: Entity<'contract'>
+  contract: Contract
   counterparty: Counterparty
   country: Entity<'country'>
   currency: Entity<'currency'>

src/model/index.ts

@@ -1,17 +1,22 @@
 // Добавить новые сущности аналогично в MetaType.ts
 
 // Model
+export * from './AbstractDemand'
+export * from './AbstractFile'
+export * from './AbstractGood'
 export * from './Account'
 export * from './Address'
 export * from './Agent'
 export * from './AgentNote'
 export * from './Attribute'
+export * from './Barcode'
 export * from './CashIn'
 export * from './CashOut'
 export * from './Collection'
 export * from './CollectionRef'
 export * from './Company'
 export * from './ContactPerson'
+export * from './Contract'
 export * from './Counterparty'
 export * from './CustomerOrder'
 export * from './CustomerOrderPosition'
@@ -23,17 +28,19 @@ export * from './DocumentWithPositions'
 export * from './Employee'
 export * from './Entity'
 export * from './EntityRef'
+export * from './File'
 export * from './Group'
 export * from './HasAttributes'
 export * from './HasCreated'
 export * from './HasDeleted'
 export * from './HasFiles'
 export * from './HasProject'
-export * from './Rate'
 export * from './HasState'
 export * from './HasStore'
 export * from './HasUpdated'
 export * from './HasVat'
+export * from './Id'
+export * from './Image'
 export * from './Invoice'
 export * from './InvoiceIn'
 export * from './InvoiceOut'
@@ -46,25 +53,19 @@ export * from './MoyskladObject'
 export * from './Order'
 export * from './Organization'
 export * from './Owned'
+export * from './Pack'
 export * from './PaymentIn'
 export * from './PaymentOut'
 export * from './Person'
 export * from './Position'
+export * from './Price'
 export * from './PriceType'
+export * from './Product'
+export * from './ProductFolder'
+export * from './Rate'
 export * from './RetailDemand'
 export * from './State'
 export * from './TaxSystem'
-export * from './Id'
-export * from './AbstractDemand'
-export * from './AbstractGood'
-export * from './Image'
-export * from './Pack'
-export * from './Barcode'
-export * from './AbstractFile'
-export * from './File'
-export * from './Price'
-export * from './Product'
-export * from './ProductFolder'
 
 // Utility types
 export * from './utils'

src/model/utils/Patch.ts

@@ -2,6 +2,7 @@ import type {
   AttributePatch,
   CashInPatch,
   CashOutPatch,
+  ContractPatch,
   CustomerOrderPatch,
   CustomerOrderPositionPatch,
   DemandPatch,
@@ -20,6 +21,7 @@ export type PatchByMetaType = {
   attributemetadata: AttributePatch
   cashin: CashInPatch
   cashout: CashOutPatch
+  contract: ContractPatch
   customerorder: CustomerOrderPatch
   customerorderposition: CustomerOrderPositionPatch
   demand: DemandPatch

test/model/Contract.test.ts

@@ -0,0 +1,33 @@
+import type { Contract, Patch } from '../../src'
+
+const t10 = {} as Contract
+
+// @ts-expect-error
+t10.contractType.rewardType
+
+if (t10.contractType === 'Commission') {
+  t10.rewardType = 'PercentOfSales'
+
+  // @ts-expect-error
+  t10.rewardPercent
+
+  if (t10.rewardType === 'PercentOfSales') {
+    t10.rewardPercent = 50
+  }
+}
+
+const t20 = {} as Patch<'contract'>
+
+// @ts-expect-error
+t20.contractType.rewardType
+
+if (t20.contractType === 'Commission') {
+  t20.rewardType = 'PercentOfSales'
+
+  // @ts-expect-error
+  t20.rewardPercent
+
+  if (t20.rewardType === 'PercentOfSales') {
+    t20.rewardPercent = 50
+  }
+}