@celigo/api-specs 0.2.201 → 0.2.203

package/dist/editransaction.yml

@@ -182,6 +182,14 @@ paths:
                     - failed
                   limit: 100
                   startDate: 1742774400000
+              sorted_by_partner:
+                summary: Sorted by trading partner name, Z to A
+                value:
+                  fileType: X12
+                  sortBy: tradingPartnerName
+                  order: desc
+                  limit: 100
+                  startDate: 1742774400000
       responses:
         '200':
           description: |-
@@ -198,6 +206,13 @@ paths:
                   summary: No matching transactions
                   value:
                     ediTransactions: []
+                sorted_empty:
+                  summary: No matches for a sorted request
+                  value:
+                    ediTransactions: []
+                    sort:
+                      sortBy: tradingPartnerName
+                      order: desc
                 x12_record:
                   summary: X12 850 inbound
                   value:
@@ -265,8 +280,249 @@ paths:
                     errors:
                       - code: invalid_date_range
                         message: please provide a valid date range
+                unsupported_sort_field:
+                  value:
+                    errors:
+                      - code: unsupported_sort_field
+                        message: 'sortBy must be one of: lastModified, tradingPartnerName'
+                invalid_sort_order:
+                  value:
+                    errors:
+                      - code: invalid_sort_order
+                        message: order must be asc or desc
         '401':
           $ref: '#/components/responses/401-unauthorized'
+  /v1/ediTransactions/download:
+    post:
+      x-internal: false
+      operationId: downloadEDITransactions
+      tags:
+        - EDI Transactions
+      summary: Download EDI transactions as CSV
+      description: |-
+        Exports one EDI standard's transactions, optionally narrowed by a keyword
+        and the B2B Manager dashboard filters, to a CSV file and returns a
+        pre-signed URL for downloading it.
+
+        The CSV opens with `#` comment lines that record the source, view mode,
+        filters, download time, and total record count (plus the keyword and
+        date range when set), followed by the column header row. Columns depend
+        on `source`, not on `viewMode`: both standards share the dashboard
+        columns (Ref doc, Doc no., Doc type, Direction, ACK status, Partner, Last
+        modified, Lifecycle status, File type), then X12 adds ISA no., GS no.,
+        ST no., ISA sender, ISA receiver, GS sender, and GS receiver, while
+        EDIFACT adds UNB no., UNH no., UNB sender, and UNB receiver; both end
+        with ACK details and MDN status.
+
+        The signed URL expires 15 minutes after generation (S3
+        `X-Amz-Expires=900`); fetch it promptly and do not persist it.
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/EDITransactionsDownloadRequest'
+            examples:
+              list_last_week:
+                summary: One week of rejected X12 transactions
+                value:
+                  source: X12
+                  viewMode: list
+                  filters:
+                    faStatus:
+                      - rejected
+                    dateRange:
+                      from: '2026-10-15'
+                      to: '2026-10-22'
+              keyword_lifecycle:
+                summary: EDIFACT transactions matching a keyword
+                value:
+                  source: EDIFACT
+                  viewMode: lifecycle
+                  keyword: '0032560422'
+      responses:
+        '200':
+          description: |-
+            Signed URL for the generated CSV. Returned even when nothing matches;
+            the CSV then holds only the comment lines and the header row.
+          content:
+            application/json:
+              schema:
+                type: object
+                required:
+                  - url
+                properties:
+                  url:
+                    type: string
+                    format: uri
+                    description: Pre-signed S3 URL for the CSV. Fetch it with a plain GET (no auth headers) within 15 minutes.
+              examples:
+                default:
+                  value:
+                    url: https://integrator-userdata-delete-30.s3.us-east-1.amazonaws.com/ediTransactions/5e58483b68b52e5827d56a86/TransactionSummary_X12_20261028_010402_5e58483b68b52e5827d56a86.csv?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAEXAMPLE%2F20261028%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20261028T010402Z&X-Amz-Expires=900&X-Amz-Security-Token=EXAMPLE-STS-TOKEN&X-Amz-SignedHeaders=host&X-Amz-Signature=7d0e5a9d2f4b6c8e1a3f7b0c5e9a2d4f8b1c3e7a0d5f2b9c4e6a8d1f3b7c0e5a
+        '400':
+          description: The request body failed validation.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                EDI_DOWNLOAD_SOURCE_REQUIRED:
+                  summary: source is missing or not X12 or EDIFACT
+                  value:
+                    errors:
+                      - code: EDI_DOWNLOAD_SOURCE_REQUIRED
+                        message: EDI file type/source (X12/EDIFACT) is missing. Ensure source is included.
+                        source: resource
+                EDI_DOWNLOAD_VIEW_MODE_REQUIRED:
+                  value:
+                    errors:
+                      - code: EDI_DOWNLOAD_VIEW_MODE_REQUIRED
+                        message: EDI transaction view mode( Lifecycle / List ) is missing. Send viewMode to download the transactions.
+                        source: resource
+                EDI_DOWNLOAD_INVALID_VIEW_MODE:
+                  value:
+                    errors:
+                      - code: EDI_DOWNLOAD_INVALID_VIEW_MODE
+                        message: The viewMode passed is invalid. The viewMode must be either "lifecycle" or "list".
+                        source: resource
+                EDI_DOWNLOAD_INVALID_KEYWORD:
+                  value:
+                    errors:
+                      - code: EDI_DOWNLOAD_INVALID_KEYWORD
+                        message: The keyword searched is not within the character limit. It must be a string between 3 to 100 characters.
+                        source: resource
+                EDI_DOWNLOAD_INVALID_SANDBOX:
+                  value:
+                    errors:
+                      - code: EDI_DOWNLOAD_INVALID_SANDBOX
+                        message: Invalid Sandbox value. Ensure a boolean value is shared for Sandbox field.
+                        source: resource
+                EDI_DOWNLOAD_INVALID_FILTERS:
+                  value:
+                    errors:
+                      - code: EDI_DOWNLOAD_INVALID_FILTERS
+                        message: Invalid filter key/ fields. Filters are not supported for one or more fields passed. Send valid filter keys to download the EDI transactions.
+                        source: resource
+                EDI_DOWNLOAD_INVALID_DATE_RANGE:
+                  value:
+                    errors:
+                      - code: EDI_DOWNLOAD_INVALID_DATE_RANGE
+                        message: Invalid date range. The 'to date' must be after 'from date'.
+                        source: resource
+        '401':
+          $ref: '#/components/responses/401-unauthorized'
+  /v1/ediTransactions/filter-options:
+    get:
+      x-internal: false
+      operationId: getEDITransactionFilterOptions
+      tags:
+        - EDI Transactions
+      summary: Get dashboard filter values
+      description: |-
+        Returns the values for the B2B Manager dashboard filter dropdowns of one
+        EDI standard: the document types and trading partners found in the
+        caller's transactions, plus the direction, functional acknowledgment,
+        lifecycle, and MDN status values the filters accept.
+      parameters:
+        - name: source
+          in: query
+          required: true
+          schema:
+            type: string
+            enum:
+              - X12
+              - EDIFACT
+            x-enumDescriptions:
+              X12: Values for the X12 tab.
+              EDIFACT: Values for the EDIFACT tab.
+          description: EDI standard to return values for. Missing or any other value fails with `invalid_source`.
+        - name: sandbox
+          in: query
+          required: false
+          schema:
+            type: boolean
+            default: false
+          description: |-
+            When true, returns values from sandbox transactions instead of
+            production ones. Anything other than `true` or `false` fails with
+            `invalid_sandbox`.
+      responses:
+        '200':
+          description: |-
+            Filter dropdown values for the requested source. `documentType` and
+            `partner` are empty arrays when the caller has no transactions for
+            the source.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/EDITransactionsFilterOptions'
+              examples:
+                no_transactions:
+                  summary: X12 on an account with no X12 transactions (lifecycleStatus shortened)
+                  value:
+                    documentType: []
+                    partner: []
+                    direction:
+                      - inbound
+                      - outbound
+                    faStatus:
+                      - notReceived
+                      - accepted
+                      - acceptedWithErrors
+                      - rejected
+                      - failed
+                      - notApplicable
+                      - inProgress
+                    lifecycleStatus:
+                      - PO received
+                      - PO sent
+                      - PO Ack received
+                      - PO Ack sent
+                      - ASN received
+                      - ASN sent
+                      - Invoice received
+                      - Invoice sent
+                      - Warehouse shipping order received
+                      - Warehouse shipping order sent
+                      - Load tender received
+                      - Load tender sent
+                    mdnStatus:
+                      - sent
+                      - received
+        '400':
+          description: A query parameter is invalid.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Error'
+              examples:
+                invalid_source:
+                  summary: source is missing or not X12 or EDIFACT
+                  value:
+                    errors:
+                      - code: invalid_source
+                        message: source must be X12 or EDIFACT
+                invalid_sandbox:
+                  summary: sandbox is not true or false
+                  value:
+                    errors:
+                      - code: invalid_sandbox
+                        message: sandbox must be a boolean
+        '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/signedURL:
     get:
       x-internal: false
@@ -1519,8 +1775,8 @@ components:
         `interchangeReceiverId`, `documentNumber`, `faStatus`, and the
         `startDate`/`endDate` window. `direction`, `documentType`, and
         `_integrationId` are accepted but not applied server-side (filter on those
-        client-side). Records come back newest-first by `lastModified` and are
-        cursor-paginated via `pageToken`.
+        client-side). Records come back newest-first by `lastModified` unless
+        `sortBy` or `order` is set, and are cursor-paginated via `pageToken`.
       properties:
         fileType:
           type: string
@@ -1644,6 +1900,54 @@ components:
             Opaque cursor from a previous response's `pageToken.next`. Pass
             this value to retrieve the next page of results. Omit on the
             first call.
+        sortBy:
+          type: string
+          enum:
+            - lastModified
+            - tradingPartnerName
+          x-enumDescriptions:
+            lastModified: Sort by last activity. This is the default.
+            tradingPartnerName: Sort by trading partner name.
+          description: |-
+            Sort column. Any other value fails with `unsupported_sort_field`. The
+            response echoes the applied sort in `sort`.
+        order:
+          type: string
+          enum:
+            - asc
+            - desc
+          x-enumDescriptions:
+            asc: Ascending.
+            desc: Descending.
+          description: |-
+            Sort direction. Defaults to `desc` for `lastModified` and `asc` for
+            `tradingPartnerName`. Sending `order` alone sorts by `lastModified`.
+            Any other value fails with `invalid_sort_order`.
+    EDITransactionsQuerySort:
+      type: object
+      required:
+        - sortBy
+        - order
+      description: Sort applied to the results. Present when the request sets `sortBy` or `order`.
+      properties:
+        sortBy:
+          type: string
+          enum:
+            - lastModified
+            - tradingPartnerName
+          x-enumDescriptions:
+            lastModified: Sorted by last activity.
+            tradingPartnerName: Sorted by trading partner name.
+          description: Column the results are sorted by.
+        order:
+          type: string
+          enum:
+            - asc
+            - desc
+          x-enumDescriptions:
+            asc: Ascending.
+            desc: Descending.
+          description: Sort direction applied, including the default when the request set only `sortBy`.
     EDITransactionsQueryResponse:
       type: object
       description: |-
@@ -1654,9 +1958,9 @@ components:
         ediTransactions:
           type: array
           description: |-
-            Matching EDI transaction records, newest first by `lastModified`.
-            Empty array when no records match — the endpoint does not switch to
-            204 for empty results.
+            Matching EDI transaction records, newest first by `lastModified`
+            unless the request sets `sortBy` or `order`. Empty array when no
+            records match — the endpoint does not switch to 204 for empty results.
           items:
             $ref: '#/components/schemas/EDITransaction'
         pageToken:
@@ -1670,6 +1974,231 @@ components:
               description: |-
                 Opaque cursor string. Pass as `pageToken` in the next request
                 body to retrieve the next page.
+        sort:
+          $ref: '#/components/schemas/EDITransactionsQuerySort'
+    EDIDashboardDirection:
+      type: string
+      enum:
+        - inbound
+        - outbound
+      x-enumDescriptions:
+        inbound: Documents received from a trading partner.
+        outbound: Documents sent to a trading partner.
+      description: Transaction direction as the dashboard filters spell it.
+    EDIDashboardFAStatus:
+      type: string
+      enum:
+        - inProgress
+        - notApplicable
+        - notReceived
+        - accepted
+        - acceptedWithErrors
+        - rejected
+        - failed
+      x-enumDescriptions:
+        inProgress: Awaiting functional acknowledgment from the trading partner.
+        notApplicable: No functional acknowledgment expected.
+        notReceived: Functional acknowledgment expected but not yet received.
+        accepted: Functional acknowledgment received and the transaction was accepted.
+        acceptedWithErrors: Functional acknowledgment received with errors, but the transaction was accepted.
+        rejected: Functional acknowledgment received and the transaction was rejected.
+        failed: Functional acknowledgment processing failed.
+      description: Functional acknowledgment status of a transaction.
+    EDIDashboardMDNStatus:
+      type: string
+      enum:
+        - sent
+        - received
+      x-enumDescriptions:
+        sent: An AS2 MDN was sent for the document.
+        received: An AS2 MDN was received for the document.
+      description: AS2 MDN status of a transaction.
+    EDIDashboardFilters:
+      type: object
+      description: |-
+        B2B Manager dashboard filter dimensions. An empty object, or one whose
+        arrays are all empty, applies no filter.
+      properties:
+        documentType:
+          type: array
+          items:
+            type: string
+          description: |-
+            Document types to match, as the X12 transaction-set code or the
+            EDIFACT message type (`850`, `ORDERS`). An X12 code labeled with its
+            functional group (`PO 850`) is read as the bare code.
+          examples:
+            - - '850'
+              - PO 810
+        direction:
+          type: array
+          items:
+            $ref: '#/components/schemas/EDIDashboardDirection'
+          description: |-
+            Directions to match. Lowercase here, unlike the capitalized
+            `direction` values on the returned records.
+        faStatus:
+          type: array
+          items:
+            $ref: '#/components/schemas/EDIDashboardFAStatus'
+          description: Functional acknowledgment statuses to match.
+        partner:
+          type: array
+          items:
+            type: string
+          description: |-
+            Trading partner names to match against each record's
+            `tradingPartnerName`. Use the values `GET /v1/ediTransactions/filter-options`
+            returns in `partner`.
+          examples:
+            - - Globex Retail
+        lifecycleStatus:
+          type: array
+          items:
+            type: string
+          description: |-
+            Order-lifecycle steps to match against each record's
+            `lifecycleStatus`. Takes the values
+            `GET /v1/ediTransactions/filter-options` returns in `lifecycleStatus`;
+            anything else is rejected.
+          examples:
+            - - PO received
+              - Invoice sent
+        mdnStatus:
+          type: array
+          items:
+            $ref: '#/components/schemas/EDIDashboardMDNStatus'
+          description: AS2 MDN statuses to match.
+        dateRange:
+          type: object
+          required:
+            - from
+            - to
+          description: Window on each record's `lastModified`.
+          properties:
+            from:
+              type: string
+              format: date
+              description: First day of the window.
+              examples:
+                - '2026-10-01'
+            to:
+              type: string
+              format: date
+              description: Last day of the window. Can equal `from`; a `to` before `from` is rejected.
+              examples:
+                - '2026-10-22'
+            fromTime:
+              type: string
+              pattern: ^([01]\d|2[0-3]):[0-5]\d:[0-5]\d$
+              description: Start time on the `from` day, so the window can begin mid-day.
+              examples:
+                - '08:30:00'
+            toTime:
+              type: string
+              pattern: ^([01]\d|2[0-3]):[0-5]\d:[0-5]\d$
+              description: End time on the `to` day, so the window can end mid-day.
+              examples:
+                - '17:45:00'
+    EDITransactionsDownloadRequest:
+      type: object
+      required:
+        - source
+        - viewMode
+      description: |-
+        Selects the transactions to export as CSV. A filter value outside a
+        dimension's accepted values fails with `EDI_DOWNLOAD_INVALID_FILTERS`,
+        and a malformed or reversed `filters.dateRange` with
+        `EDI_DOWNLOAD_INVALID_DATE_RANGE`. Unknown filter keys and
+        `filters.documentType` values are not checked.
+      properties:
+        source:
+          type: string
+          enum:
+            - X12
+            - EDIFACT
+          x-enumDescriptions:
+            X12: Export ANSI X12 transactions.
+            EDIFACT: Export UN/EDIFACT transactions.
+          description: |-
+            EDI standard to export. Missing or any other value, lowercase
+            included, fails with `EDI_DOWNLOAD_SOURCE_REQUIRED`.
+        viewMode:
+          type: string
+          enum:
+            - lifecycle
+            - list
+          x-enumDescriptions:
+            lifecycle: The export was taken from the lifecycle view.
+            list: The export was taken from the list view.
+          description: |-
+            Dashboard view the export is taken from, recorded in the CSV's
+            comment lines. Missing fails with `EDI_DOWNLOAD_VIEW_MODE_REQUIRED`;
+            any other value, `dual` included, fails with
+            `EDI_DOWNLOAD_INVALID_VIEW_MODE`.
+        keyword:
+          type: string
+          minLength: 3
+          maxLength: 100
+          description: |-
+            Narrows the export to transactions matching this text and is recorded
+            as `Search` in the CSV's comment lines. A shorter or longer value
+            fails with `EDI_DOWNLOAD_INVALID_KEYWORD`.
+        sandbox:
+          type: boolean
+          default: false
+          description: |-
+            When true, exports sandbox transactions instead of production ones.
+            A non-boolean fails with `EDI_DOWNLOAD_INVALID_SANDBOX`.
+        filters:
+          $ref: '#/components/schemas/EDIDashboardFilters'
+    EDITransactionsFilterOptions:
+      type: object
+      required:
+        - documentType
+        - partner
+        - direction
+        - faStatus
+        - lifecycleStatus
+        - mdnStatus
+      description: |-
+        Values for the dashboard filter dropdowns of one EDI standard. Pass them
+        back in `filters` on `POST /v1/ediTransactions/download`.
+      properties:
+        documentType:
+          type: array
+          items:
+            type: string
+          description: Distinct document types among the caller's transactions for the requested source.
+        partner:
+          type: array
+          items:
+            type: string
+          description: Distinct trading partner names among the caller's transactions for the requested source.
+        direction:
+          type: array
+          items:
+            $ref: '#/components/schemas/EDIDashboardDirection'
+          description: Directions the `direction` filter accepts.
+        faStatus:
+          type: array
+          items:
+            $ref: '#/components/schemas/EDIDashboardFAStatus'
+          description: Functional acknowledgment statuses the `faStatus` filter accepts.
+        lifecycleStatus:
+          type: array
+          items:
+            type: string
+          description: |-
+            Order-lifecycle steps the `lifecycleStatus` filter accepts. Besides
+            the order-cycle steps listed under the EDI transaction's
+            `lifecycleStatus`, production lists steps for other document types,
+            such as warehouse, transport, and freight documents.
+        mdnStatus:
+          type: array
+          items:
+            $ref: '#/components/schemas/EDIDashboardMDNStatus'
+          description: AS2 MDN statuses the `mdnStatus` filter accepts.
     EDITransactionsSignedUrlResponse:
       type: object
       description: |-

package/dist/export.yml

@@ -491,8 +491,9 @@ paths:
         returned. Configuration errors in the export doc surface in the
         `errors[]` and `stages[].errors[]` arrays within a 200 response, but
         not every failure does: structural validation failures (e.g. missing
-        `_connectionId`) return 4xx, and so does an output filter that can't
-        read a record's value (see the 422 response).
+        `_connectionId`) return 4xx, and so do an output filter that can't
+        read a record's value and a Google Cloud Storage bucket or object that
+        doesn't exist (see the 422 response).
       requestBody:
         required: true
         content:
@@ -524,9 +525,9 @@ paths:
         '200':
           description: |-
             Preview envelope for a preview that ran; a valid body can still answer
-            422 (see that response). User-error in
+            422 for the failures that response lists. Other user errors in
             the export config (handlebars template failures, runtime errors)
-            surfaces in `errors[]` and `stages[].errors[]`; inspect those before
+            surface in `errors[]` and `stages[].errors[]`; inspect those before
             trusting `stages[].data[]`.
           content:
             application/json:
@@ -559,7 +560,9 @@ paths:
             with 422 when a record holds a value its type conversion can't read,
             such as an empty or non-date string under `epochtime`: the message is
             "Invalid date. Cannot convert given string or number to date time.",
-            followed by `; record=` and that record as JSON.
+            followed by `; record=` and that record as JSON. A Google Cloud Storage
+            read of a bucket or object that doesn't exist fails with 422
+            `gcs_bucket_not_found` or `gcs_object_not_found`.
           content:
             application/json:
               schema:
@@ -571,6 +574,13 @@ paths:
                       - code: missing_required_field
                         message: The `_connectionId` field is required for this preview.
                         source: _connectionId
+                gcsBucketNotFound:
+                  summary: Google Cloud Storage bucket that doesn't exist
+                  value:
+                    errors:
+                      - code: gcs_bucket_not_found
+                        message: The specified Google Cloud Storage bucket was not found. Verify the bucket name and that the service account has access.
+                        source: resource
   /v1/integrations/{_integrationId}/flows/{_flowId}/exports/preview:
     post:
       x-internal: false
@@ -5841,7 +5851,8 @@ components:
               description: |-
                 Provider-native ID of the storage root (e.g. a Google Drive shared-drive ID) the relative
                 path resolves against; set when pathMode is relativePath. The provider's own ID, not a Celigo ID.
-                For Google Cloud Storage it is the bucket name.
+                For Google Cloud Storage it is the bucket name, and a bucket that doesn't exist fails the
+                export preview with 422 `gcs_bucket_not_found`.
               examples:
                 - 1qU1hvFarBFMb4-twqKm1rR5o_6j9vs9g
                 - erp-exports