Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DXP-1420 list params for campaign_id and status #473

Merged
merged 4 commits into from
Nov 28, 2023
Merged

DXP-1420 list params for campaign_id and status #473

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
ef91ee5
DXP-1420 list params for campaign_id and status
mike-r-morgan Nov 22, 2023
d2107ca
DXP-1420 apply pattern for all references
mike-r-morgan Nov 27, 2023
f8b8484
DXP-1420 merge with main
mike-r-morgan Nov 27, 2023
4053815
DXP-1420 bump version
mike-r-morgan Nov 27, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
73 changes: 52 additions & 21 deletions dist/lob-api-bundled.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3
info:
title: Lob
version: 1.19.21
version: 1.19.22
description: >
The Lob API is organized around REST. Our API is designed to have
predictable, resource-oriented URLs and uses HTTP response codes to indicate
Expand Down Expand Up @@ -6970,6 +6970,21 @@ components:
anyOf:
- format: date-time
- format: date
status:
type: string
enum:
- processed
- rendered
- failed
description: >
A string describing the PDF render status:

* `processed` - the rendering process is currently in progress.

* `rendered` - a PDF has been successfully rendered of the mailpiece.

* `failed` - one or more issues has caused the rendering process to
fail.
merge_variables:
type: object
description: >-
Expand Down Expand Up @@ -7440,11 +7455,7 @@ components:
use_type:
$ref: '#/components/schemas/chk_use_type'
status:
title: The status of the check.
enum:
- processed
- rendered
- failed
$ref: '#/components/schemas/status'
failure_reason:
allOf:
- $ref: '#/components/schemas/failure_reason'
Expand Down Expand Up @@ -8553,11 +8564,7 @@ components:
to learn more. Not available for `A4` letter size.
default: false
status:
title: The status of the letter.
enum:
- processed
- rendered
- failed
$ref: '#/components/schemas/status'
failure_reason:
allOf:
- $ref: '#/components/schemas/failure_reason'
Expand Down Expand Up @@ -8956,6 +8963,12 @@ components:
$ref: '#/components/schemas/ltr_id'
deleted:
$ref: '#/components/schemas/deleted'
campaign_id:
type: string
pattern: ^cmp_[a-zA-Z0-9]+$
description: >
optional field which filers resources created by the provided campaign
mike-r-morgan marked this conversation as resolved.
Show resolved Hide resolved
id, prefixed with `cmp_`.
input_to:
type: object
properties:
Expand Down Expand Up @@ -9280,11 +9293,7 @@ components:
to learn more. Not available for `4x6` or `A5` postcard sizes.
default: false
status:
title: The status of the postcard.
enum:
- processed
- rendered
- failed
$ref: '#/components/schemas/status'
failure_reason:
allOf:
- $ref: '#/components/schemas/failure_reason'
Expand Down Expand Up @@ -9615,11 +9624,7 @@ components:
to learn more. Not available for `11x9_bifold` self-mailer size.
default: false
status:
title: The status of the self mailer.
enum:
- processed
- rendered
- failed
$ref: '#/components/schemas/status'
failure_reason:
allOf:
- $ref: '#/components/schemas/failure_reason'
Expand Down Expand Up @@ -10574,6 +10579,16 @@ components:
- date_created
- required:
- send_date
status:
in: query
name: status
description: |
A string describing the render status:
* `processed` - the rendering process is currently underway.
* `rendered` - the rendering process has completed successfully.
* `failed` - the rendering process has failed.
schema:
$ref: '#/components/schemas/status'
idem-header:
in: header
name: Idempotency-Key
Expand All @@ -10600,6 +10615,15 @@ components:
type: string
maxLength: 256
example: 026e7634-24d7-486c-a0bb-4a17fd0eebc5
campaign_id:
in: query
name: campaign_id
required: false
mike-r-morgan marked this conversation as resolved.
Show resolved Hide resolved
description: >
optional field which filers resources created by the provided campaign
mike-r-morgan marked this conversation as resolved.
Show resolved Hide resolved
id, prefixed with `cmp_`.
schema:
$ref: '#/components/schemas/campaign_id'
responses:
address_error:
description: Error
Expand Down Expand Up @@ -17693,6 +17717,7 @@ paths:
- $ref: '#/components/parameters/send_date'
- $ref: '#/components/parameters/mail_type'
- $ref: '#/components/parameters/sort_by'
- $ref: '#/components/parameters/status'
responses:
'200':
$ref: '#/components/responses/all_checks'
Expand Down Expand Up @@ -19740,6 +19765,8 @@ paths:
- $ref: '#/components/parameters/include'
- $ref: '#/components/parameters/date_created'
- $ref: '#/components/parameters/metadata'
- $ref: '#/components/parameters/campaign_id'
- $ref: '#/components/parameters/status'
- in: query
name: color
description: >-
Expand Down Expand Up @@ -20861,6 +20888,8 @@ paths:
- $ref: '#/components/parameters/include'
- $ref: '#/components/parameters/date_created'
- $ref: '#/components/parameters/metadata'
- $ref: '#/components/parameters/campaign_id'
- $ref: '#/components/parameters/status'
- in: query
name: size
description: >-
Expand Down Expand Up @@ -22884,6 +22913,8 @@ paths:
- $ref: '#/components/parameters/send_date'
- $ref: '#/components/parameters/mail_type'
- $ref: '#/components/parameters/sort_by'
- $ref: '#/components/parameters/campaign_id'
- $ref: '#/components/parameters/status'
responses:
'200':
$ref: '#/components/responses/all_self_mailers'
Expand Down
Loading
Loading