@celigo/api-specs 0.2.39 → 0.2.41

package/dist/ediprofile.yml

@@ -770,6 +770,13 @@ components:
           description: Display name of the dependent resource.
           examples:
             - Import Orders to NetSuite
+        type:
+          type: string
+          description: |-
+            Sub-type of the dependent resource when its collection distinguishes one, such as
+            `stream` for a listener export. Only present for resource types that carry a `type`.
+          examples:
+            - stream
         paths:
           type: array
           description: |-

package/dist/editransaction.yml

@@ -209,6 +209,9 @@ paths:
                         fileType: X12
                         documentType: '850'
                         documentNumber: PO03302026A
+                        referenceDocumentNumber:
+                          - PO PO03302026A
+                        lifecycleStatus: PO received
                         direction: Inbound
                         faStatus: inProgress
                         sandbox: false
@@ -267,6 +270,145 @@ paths:
                         message: please provide a valid date range
         '401':
           $ref: '#/components/responses/401-unauthorized'
+  /v1/ediTransactions/signedURL:
+    get:
+      x-internal: false
+      operationId: getEdiTransactionsSignedUrl
+      tags:
+        - EDI Transactions
+      summary: Get signed URL to download EDI transactions CSV
+      description: |-
+        Exports EDI transaction-log records matching a `lastModified` date window
+        to a CSV file and returns a short-lived pre-signed S3 URL for downloading
+        it — the API equivalent of the B2B Manager dashboard's transaction
+        download.
+
+        When `startDate` and `endDate` are both omitted, the export covers the
+        last 24 hours. When the window matches more records than the server-side
+        export cap, the request fails with `exceeded_max_ediTransactions` —
+        narrow the window and retry.
+
+        CSV columns for X12 exports: Doc no., Doc type, FA status, File type,
+        Direction, Processed, ISA no., GS no., ST no., ISA sender, ISA receiver,
+        GS sender, GS receiver, FA details, MDN status. EDIFACT exports replace
+        FA status with ACK status and the ISA/GS/ST columns with UNB no.,
+        UNH no., UNB sender, UNB receiver. The Processed timestamp is rendered
+        in the account owner's timezone preference.
+
+        The signed URL expires 15 minutes after generation (S3
+        `X-Amz-Expires=900`) — fetch it promptly and do not persist it. To browse
+        transaction records via the API instead, use
+        `POST /v1/ediTransactions/query`.
+      parameters:
+        - name: fileType
+          in: query
+          required: false
+          schema:
+            type: string
+            enum:
+              - X12
+              - EDIFACT
+            x-enumDescriptions:
+              X12: Export the ANSI X12 transaction log.
+              EDIFACT: Export the UN/EDIFACT transaction log.
+          description: |-
+            Which transaction log to export. Defaults to `X12` when omitted —
+            pass `fileType=EDIFACT` explicitly to export EDIFACT records. The
+            two logs produce different CSV columns.
+        - name: startDate
+          in: query
+          required: false
+          schema:
+            type: integer
+            format: int64
+            examples:
+              - 1742774400000
+          description: |-
+            Lower bound of the `lastModified` window, as epoch milliseconds
+            (non-numeric values are rejected). When both `startDate` and
+            `endDate` are omitted, the window defaults to the last 24 hours.
+        - name: endDate
+          in: query
+          required: false
+          schema:
+            type: integer
+            format: int64
+            examples:
+              - 1745452800000
+          description: |-
+            Upper bound of the `lastModified` window, as epoch milliseconds
+            (non-numeric values are rejected). Must be greater than `startDate`.
+            Defaults to the current time when only `startDate` is provided —
+            sending `endDate` without `startDate` fails with
+            `start_time_or_end_time_missing`.
+      responses:
+        '200':
+          description: |-
+            Signed URL for the generated CSV export. Returned even when zero
+            records match the window — the CSV then contains only the header
+            row.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EDITransactionsSignedUrlResponse'
+              examples:
+                default:
+                  summary: Signed URL for the CSV export
+                  value:
+                    url: https://integrator-userdata-delete-30.s3.us-east-1.amazonaws.com/ediTransactions/5e58483b68b52e5827d56a86/TransactionSummary_20260614_20260713_5e58483b68b52e5827d56a86.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAEXAMPLE%2F20260713%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260713T120000Z&X-Amz-Expires=900&X-Amz-Security-Token=EXAMPLE-STS-TOKEN&X-Amz-SignedHeaders=host&X-Amz-Signature=7d0e5a9d2f4b6c8e1a3f7b0c5e9a2d4f8b1c3e7a0d5f2b9c4e6a8d1f3b7c0e5a
+        '400':
+          description: |-
+            The request failed validation, or the date window matches more
+            records than the server-side export cap.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                end_date_without_start_date:
+                  summary: endDate sent without startDate
+                  value:
+                    errors:
+                      - code: start_time_or_end_time_missing
+                        message: start time or end time missing
+                invalid_start_or_end_time:
+                  summary: Non-numeric startDate or endDate
+                  value:
+                    errors:
+                      - code: invalid_start_time_or_end_time
+                        message: please provide a valid start time or end time
+                invalid_date_range:
+                  summary: startDate is not before endDate
+                  value:
+                    errors:
+                      - code: invalid_date_range
+                        message: please provide a valid date range
+                invalid_filetype:
+                  summary: fileType is not X12 or EDIFACT
+                  value:
+                    errors:
+                      - code: invalid_filetype
+                        message: 'fileType is invalid. fileType should be one of the following: X12, EDIFACT'
+                too_many_records:
+                  summary: Window matches more records than the export cap
+                  value:
+                    errors:
+                      - code: exceeded_max_ediTransactions
+                        message: Too many records found. Please narrow your search criteria for more precise results.
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+        '422':
+          description: The account's subscription does not include a B2B / EDI license.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                no_edi_license:
+                  value:
+                    errors:
+                      - code: edi_subscription_required
+                        message: EDI is a premium feature that is not included in your account's current subscription plan. Please upgrade your account to get access to B2B Manager.
   /v1/ediTransactions/{_ediTransactionId}/faDetails:
     get:
       x-internal: false
@@ -758,6 +900,71 @@ components:
             documents. May also be an empty string.
           examples:
             - PO03302026A
+        referenceDocumentNumber:
+          type: array
+          description: |-
+            Business documents this one refers back to, each as an upper-cased
+            `<qualifier> <number>` string — for example the purchase order an
+            856 ASN or 810 invoice fulfils. Links the documents of one order
+            lifecycle together. Present only when the file definition extracted
+            at least one reference.
+          items:
+            type: string
+          examples:
+            - - PO RV850-100001
+        lifecycleStatus:
+          type: string
+          enum:
+            - PO received
+            - PO sent
+            - PO Ack received
+            - PO Ack sent
+            - PO change req received
+            - PO change req sent
+            - ASN received
+            - ASN sent
+            - Invoice received
+            - Invoice sent
+            - Payment received
+            - Payment sent
+          x-enumDescriptions:
+            PO received: Inbound 850 or ORDERS — a purchase order arrived from the trading partner
+            PO sent: Outbound 850 or ORDERS — a purchase order was sent to the trading partner
+            PO Ack received: Inbound 855 or ORDRSP — the partner acknowledged a purchase order
+            PO Ack sent: Outbound 855 or ORDRSP — a purchase-order acknowledgement was sent
+            PO change req received: Inbound 860 or ORDCHG — the partner requested a purchase-order change
+            PO change req sent: Outbound 860 or ORDCHG — a purchase-order change request was sent
+            ASN received: Inbound 856 or DESADV — an advance ship notice arrived
+            ASN sent: Outbound 856 or DESADV — an advance ship notice was sent
+            Invoice received: Inbound 810 or INVOIC — an invoice arrived
+            Invoice sent: Outbound 810 or INVOIC — an invoice was sent
+            Payment received: Inbound 820 — a payment or remittance advice arrived
+            Payment sent: Outbound 820 — a payment or remittance advice was sent
+          description: |-
+            Order-lifecycle step this document represents, derived from
+            `documentType` and `direction`. Absent when the document type is
+            outside the order cycle (functional acknowledgements, inventory and
+            status documents) and on records that predate lifecycle tracking.
+          examples:
+            - PO received
+        tradingPartnerName:
+          type: string
+          description: |-
+            Display name of the trading partner the document was exchanged with.
+            Present only when the flow resolved the partner; drives the partner
+            filter of the B2B Manager dashboard.
+          examples:
+            - Best Buy
+        partnerPairKey:
+          type: string
+          description: |-
+            Upper-cased key identifying the trading-partner pair that exchanged
+            the document, shared by every document of that pair so an order
+            lifecycle can be followed across documents together with
+            `referenceDocumentNumber`. Present only when the flow resolved the
+            partner.
+          examples:
+            - ACME:BESTBUY
         direction:
           type: string
           enum:
@@ -1125,6 +1332,24 @@ components:
               description: |-
                 Opaque cursor string. Pass as `pageToken` in the next request
                 body to retrieve the next page.
+    EDITransactionsSignedUrlResponse:
+      type: object
+      description: |-
+        Location of the CSV export generated from the matching EDI transaction
+        records.
+      properties:
+        url:
+          type: string
+          format: uri
+          description: |-
+            Pre-signed S3 URL that streams the CSV export when fetched with a
+            plain GET (no auth headers needed). Expires 15 minutes after
+            generation (S3 `X-Amz-Expires=900`) — fetch it promptly, do not
+            persist it.
+          examples:
+            - https://integrator-userdata-delete-30.s3.us-east-1.amazonaws.com/ediTransactions/5e58483b68b52e5827d56a86/TransactionSummary_20260614_20260713_5e58483b68b52e5827d56a86.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Expires=900&X-Amz-SignedHeaders=host&X-Amz-Signature=4f9b2c1e8a3d7f0b5c6e9a2d4f8b1c3e7a0d5f2b9c4e6a8d1f3b7c0e5a9d2f4b
+      required:
+        - url
     EDITransactionMdnResponse:
       type: object
       description: |-