@endevops/peppol-schema 0.0.1 → 0.1.0-beta.2

package/dist/effect/peppol-document-response-document-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"peppol-document-response-document-schema.js","names":[],"sources":["../../src/effect/peppol-document-response-document-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { applicationResponseTypeCodeSchema } from './values/application-response-type-code-schema';\n\n/**\n * @summary Response information\n *\n * @name `cac:Response`\n *\n * @cardinality (1..1)\n *\n * @see {@link messageLevelResponseDocumentResponseSchema}\n */\nexport const peppolDocumentResponseDocumentSchema = Schema.Struct({\n  /**\n   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative\n   * response states that the document was not processed because of identified issues.\n   *\n   * @example\n   *   `RE`;\n   *\n   * @summary Message response code\n   *\n   * @name `cbc:ResponseCode`\n   */\n  responseCode: applicationResponseTypeCodeSchema(),\n  /**\n   * @description Used to meake any comments or instructions relevant to the response. The use of this element requires manual assessment by the receiver.\n   *\n   * @summary Response textual notes\n   */\n  description: Schema.optional(Schema.String),\n});\n\nexport type PeppolMessageLevelResponseDocumentResponseDocument = typeof peppolDocumentResponseDocumentSchema.Type;\n"],"mappings":";;;;;;;;;;;;AAaA,MAAa,uCAAuC,OAAO,OAAO;;;;;;;;;;;;CAYhE,cAAc,kCAAkC;;;;;;CAMhD,aAAa,OAAO,SAAS,OAAO,MAAM;AAC5C,CAAC"}

package/dist/effect/peppol-document-response-line-response-content-schema.d.ts

@@ -0,0 +1,43 @@
+import { Schema } from "effect";
+//#region src/effect/peppol-document-response-line-response-content-schema.d.ts
+export declare const peppolDocumentResponseLineResponseContentSchema: Schema.Struct<{
+  /**
+   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+   * response states that the document was not processed because of identified issues.
+   *
+   * @example
+   *   `RE`;
+   *
+   * @summary Line response code
+   *
+   * @name `cbc:ResponseCode`
+   */
+  readonly responseCode: Schema.Literals<readonly ["AB", "AP", "RE"]>;
+  /**
+   * @description The description of the issued identifier in the transaction document.
+   *
+   * @example
+   *   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;
+   *
+   * @summary Issue description
+   *
+   * @name `cbc:Description`
+   */
+  readonly description: Schema.String;
+  /**
+   * @name `cac:Status`
+   */
+  readonly status: Schema.Struct<{
+    /**
+     * @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...
+     *
+     * @summary Issue type coded
+     *
+     * @name `cbc:StatusReasonCode`
+     */
+    readonly statusReasonCode: Schema.Literals<readonly ["BV", "BW", "SV"]>;
+  }>;
+}>;
+export type DocumentResponseLineResponseContent = typeof peppolDocumentResponseLineResponseContentSchema.Type;
+//#endregion
+//# sourceMappingURL=peppol-document-response-line-response-content-schema.d.ts.map

package/dist/effect/peppol-document-response-line-response-content-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"peppol-document-response-line-response-content-schema.d.ts","names":[],"sources":["../../src/effect/peppol-document-response-line-response-content-schema.ts"],"mappings":";;qBAIa,iDAA+C,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YAuChD,6CAA6C,gDAAgD"}

package/dist/effect/peppol-document-response-line-response-content-schema.js

@@ -0,0 +1,48 @@
+import { applicationResponseTypeCodeSchema } from "./values/application-response-type-code-schema.js";
+import { Schema } from "effect";
+//#region src/effect/peppol-document-response-line-response-content-schema.ts
+const peppolDocumentResponseLineResponseContentSchema = Schema.Struct({
+	/**
+	* @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative
+	* response states that the document was not processed because of identified issues.
+	*
+	* @example
+	*   `RE`;
+	*
+	* @summary Line response code
+	*
+	* @name `cbc:ResponseCode`
+	*/
+	responseCode: applicationResponseTypeCodeSchema(),
+	/**
+	* @description The description of the issued identifier in the transaction document.
+	*
+	* @example
+	*   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;
+	*
+	* @summary Issue description
+	*
+	* @name `cbc:Description`
+	*/
+	description: Schema.String,
+	/**
+	* @name `cac:Status`
+	*/
+	status: Schema.Struct({ 
+	/**
+	* @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...
+	*
+	* @summary Issue type coded
+	*
+	* @name `cbc:StatusReasonCode`
+	*/
+statusReasonCode: Schema.Literals([
+		"BV",
+		"BW",
+		"SV"
+	]) })
+});
+//#endregion
+export { peppolDocumentResponseLineResponseContentSchema };
+
+//# sourceMappingURL=peppol-document-response-line-response-content-schema.js.map

package/dist/effect/peppol-document-response-line-response-content-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"peppol-document-response-line-response-content-schema.js","names":[],"sources":["../../src/effect/peppol-document-response-line-response-content-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { applicationResponseTypeCodeSchema } from './values/application-response-type-code-schema';\n\nexport const peppolDocumentResponseLineResponseContentSchema = Schema.Struct({\n  /**\n   * @description An indicator stating whether the referenced message was cleared through validation and advanced to the next step in the process. A negative\n   * response states that the document was not processed because of identified issues.\n   *\n   * @example\n   *   `RE`;\n   *\n   * @summary Line response code\n   *\n   * @name `cbc:ResponseCode`\n   */\n  responseCode: applicationResponseTypeCodeSchema(),\n  /**\n   * @description The description of the issued identifier in the transaction document.\n   *\n   * @example\n   *   `Validation gives error [CL-T77-R0002]- Tax categories MUST be coded using UN/ECE 5305 code list`;\n   *\n   * @summary Issue description\n   *\n   * @name `cbc:Description`\n   */\n  description: Schema.String,\n  /**\n   * @name `cac:Status`\n   */\n  status: Schema.Struct({\n    /**\n     * @description A codified version of the issue description that describes the nature of the issue. e.g. Syntax violation, business rule violation, ...\n     *\n     * @summary Issue type coded\n     *\n     * @name `cbc:StatusReasonCode`\n     */\n    statusReasonCode: Schema.Literals(['BV', 'BW', 'SV']),\n  }),\n});\n\nexport type DocumentResponseLineResponseContent = typeof peppolDocumentResponseLineResponseContentSchema.Type;\n"],"mappings":";;;AAIA,MAAa,kDAAkD,OAAO,OAAO;;;;;;;;;;;;CAY3E,cAAc,kCAAkC;;;;;;;;;;;CAWhD,aAAa,OAAO;;;;CAIpB,QAAQ,OAAO,OAAO;;;;;;;;AAQpB,kBAAkB,OAAO,SAAS;EAAC;EAAM;EAAM;CAAI,CAAC,EACtD,CAAC;AACH,CAAC"}

package/dist/effect/peppol-document-response-line-response-schema.d.ts

@@ -0,0 +1,38 @@
+import { Schema } from "effect";
+//#region src/effect/peppol-document-response-line-response-schema.d.ts
+export declare const peppolDocumentResponseLineResponseSchema: Schema.Struct<{
+  /**
+   * @description Identifies the line in the business document to which the reported issue applies.
+   *
+   * @summary Line reference
+   *
+   * @name `cac:LineReference`
+   */
+  readonly lineReference: Schema.Struct<{
+    /**
+     * @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business
+     * document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to
+     * provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is
+     * mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.
+     *
+     * @example
+     *   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;
+     *
+     * @summary Section identifier
+     */
+    readonly lineId: Schema.String;
+  }>;
+  /**
+   * @summary Line response information
+   */
+  readonly response: Schema.Struct<{
+    readonly responseCode: Schema.Literals<readonly ["AB", "AP", "RE"]>;
+    readonly description: Schema.String;
+    readonly status: Schema.Struct<{
+      readonly statusReasonCode: Schema.Literals<readonly ["BV", "BW", "SV"]>;
+    }>;
+  }>;
+}>;
+export type PeppolMessageLevelDocumentResponseLineResponse = typeof peppolDocumentResponseLineResponseSchema.Type;
+//#endregion
+//# sourceMappingURL=peppol-document-response-line-response-schema.d.ts.map

package/dist/effect/peppol-document-response-line-response-schema.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"peppol-document-response-line-response-schema.d.ts","names":[],"sources":["../../src/effect/peppol-document-response-line-response-schema.ts"],"mappings":";;qBAIa,0CAAwC,OAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;YA4BzC,wDAAwD,yCAAyC"}

package/dist/effect/peppol-document-response-line-response-schema.js

@@ -0,0 +1,33 @@
+import { peppolDocumentResponseLineResponseContentSchema } from "./peppol-document-response-line-response-content-schema.js";
+import { Schema } from "effect";
+//#region src/effect/peppol-document-response-line-response-schema.ts
+const peppolDocumentResponseLineResponseSchema = Schema.Struct({
+	/**
+	* @description Identifies the line in the business document to which the reported issue applies.
+	*
+	* @summary Line reference
+	*
+	* @name `cac:LineReference`
+	*/
+	lineReference: Schema.Struct({ 
+	/**
+	* @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business
+	* document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to
+	* provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is
+	* mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.
+	*
+	* @example
+	*   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;
+	*
+	* @summary Section identifier
+	*/
+lineId: Schema.String }),
+	/**
+	* @summary Line response information
+	*/
+	response: peppolDocumentResponseLineResponseContentSchema
+});
+//#endregion
+export { peppolDocumentResponseLineResponseSchema };
+
+//# sourceMappingURL=peppol-document-response-line-response-schema.js.map

package/dist/effect/peppol-document-response-line-response-schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"peppol-document-response-line-response-schema.js","names":[],"sources":["../../src/effect/peppol-document-response-line-response-schema.ts"],"sourcesContent":["import { Schema } from 'effect';\n\nimport { peppolDocumentResponseLineResponseContentSchema } from './peppol-document-response-line-response-content-schema';\n\nexport const peppolDocumentResponseLineResponseSchema = Schema.Struct({\n  /**\n   * @description Identifies the line in the business document to which the reported issue applies.\n   *\n   * @summary Line reference\n   *\n   * @name `cac:LineReference`\n   */\n  lineReference: Schema.Struct({\n    /**\n     * @description Identifies the section of the document to which the reported issue applied. The LineID element mustbe used to indicate where in the business\n     * document the error occurred by using XPath to reference the element causing the error. To cater for scenarios where it is not possible to\n     * provide XPath, a dummy value must be applied. The dummay value must consist of the characters NA. This is due to that the LineID element is\n     * mendatory in the ApplicationResponse message in UBL 2.1 on which the MLR message is based.\n     *\n     * @example\n     *   `/Catalogue/cac:CatalogueLine[3]/cac:Item[1]/cac:ClassifiedTaxCategory[1]/cbc:ID[1]`;\n     *\n     * @summary Section identifier\n     */\n    lineId: Schema.String,\n  }),\n  /**\n   * @summary Line response information\n   */\n  response: peppolDocumentResponseLineResponseContentSchema,\n});\n\nexport type PeppolMessageLevelDocumentResponseLineResponse = typeof peppolDocumentResponseLineResponseSchema.Type;\n"],"mappings":";;;AAIA,MAAa,2CAA2C,OAAO,OAAO;;;;;;;;CAQpE,eAAe,OAAO,OAAO;;;;;;;;;;;;AAY3B,QAAQ,OAAO,OACjB,CAAC;;;;CAID,UAAU;AACZ,CAAC"}