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

Jump to bottom

CMB-645: add list, get and delete endpoints for snap packs #495

Merged
merged 1 commit into from
Jun 6, 2024
Merged

CMB-645: add list, get and delete endpoints for snap packs #495

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/chunks/bundle.js
View file
Open in desktop

Large diffs are not rendered by default.

336 changes: 207 additions & 129 deletions docs/index.html
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 3 additions & 1 deletion lob-api-public.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.3

Check warning on line 1 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

oas3-valid-media-example 

This format violates OpenAPI 3.1 rules
info:
title: Lob
version: 1.19.33
version: 1.19.34
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 any API errors. <p>
license:
Expand Down Expand Up @@ -914,7 +914,7 @@
<div class="back-to-top" ><a href="#" onclick="toTopLink()">back to top</a></div>
- name: Getting Started
x-traitTag: true
description: |

Check warning on line 917 in lob-api-public.yml

View workflow job for this annotation

GitHub Actions / Lint (push)

no-script-tags-in-markdown 

Markdown descriptions must not have "<script>" tags.
### 1. Get Setup
* Create an account at <a href="https://dashboard.lob.com/#/register" target="_blank">Lob.com</a>
* Obtain your API keys in the Lob dashboard <a href="https://dashboard.lob.com/settings/api-keys" target="_blank">settings</a>
Expand Down Expand Up @@ -2498,6 +2498,8 @@
$ref: resources/self_mailers/self_mailer.yml
/self_mailers:
$ref: resources/self_mailers/self_mailers.yml
/snap_packs/{snap_pack_id}:
$ref: resources/snap_packs/snap_pack.yml
/snap_packs:
$ref: resources/snap_packs/snap_packs.yml
/templates/{tmpl_id}/versions/{vrsn_id}:
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@lob/openapi",
"version": "1.19.33",
"version": "1.19.34",
"engines": {
"node": ">=14.16.0",
"npm": ">=7.9.0"
Expand Down
155 changes: 155 additions & 0 deletions resources/snap_packs/responses/all_snap_packs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
description: >-
A dictionary with a data property that contains an array of
up to `limit` snap_packs. Each entry in the array is a separate
self_mailer. The previous and next page of snap_packs can be retrieved
by calling the endpoint contained in the `previous_url` and
`next_url` fields in the API response respectively.<br>If no
more snap_packs are available beyond the current set of returned results,
the `next_url` field will be empty.

content:
application/json:
schema:
allOf:
- $ref: "../../../shared/models/list.yml"
- type: object
properties:
data:
type: array
description: list of snap_packs
items:
$ref: "../models/snap_pack.yml"

example:
data:
- id: ord_0d6a16a3fff6318ac8f8008dc1
description: April Campaign
to:
id: adr_bae820679f3f536b
description:
name: HARRY ZHANG
company:
phone:
email:
address_line1: 210 KING ST STE 6100
address_line2:
address_city: SAN FRANCISCO
address_state: CA
address_zip: 94107-1741
address_country: UNITED STATES
metadata: {}
date_created: "2017-09-05T17:47:53.767Z"
date_modified: "2017-09-05T17:47:53.767Z"
deleted: true
object: address
from:
id: adr_210a8d4b0b76d77b
description:
name: LEORE AVIDAR
company:
phone:
email:
address_line1: 210 KING ST STE 6100
address_line2:
address_city: SAN FRANCISCO
address_state: CA
address_zip: 94107-1741
address_country: UNITED STATES
metadata: {}
date_created: "2017-09-05T17:47:53.767Z"
date_modified: "2017-09-05T17:47:53.767Z"
deleted: true
object: address
url: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d.pdf?version=v1&expires=1618512040&signature=qvyCqXI1ndBvc4AjvG8FlirqLXEcfmYo4sDrRtabaXMOsX88to9G3K49uIk_aqevvZXe8HoRYD_nWydbQHqaCA
outside_template_id: tmpl_a3cb937f26d7eec
inside_template_id: tmpl_a3cb937f26d7eec
inside_template_version_id: vrsn_bfdf70893b00a85
outside_template_version_id: vrsn_bfdf70893b00a85
carrier: USPS
tracking_events: []
thumbnails:
- small: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_small_1.png?version=v1&expires=1618512040&signature=-bipeUHP-hAMcCBSrWM0ZH1VwRdSPNVGGZN9hAZKr6Lh4ly6uxvratVd5LXJCK_zOEMYk_mTWASt0ge7OY6SDA
medium: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_medium_1.png?version=v1&expires=1618512040&signature=ryxN7bsXGtw_GRFSP3Cs3A3IYjxZi3cW9BHDCNgMt6p3nobVmsc_iFHt2e-S7ndAXhhN7nP-MQVov3bt3r37BQ
large: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_large_1.png?version=v1&expires=1618512040&signature=kBrm00xkyCkJNJRHxH8HshFaebtOxnzjVWOs1VVmGMuw8H6OBNcMAMxt9s49K0jlpHoh3Nr9uSncEZMQaaNjAg
- small: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_small_2.png?version=v1&expires=1618512040&signature=3gTgU7Fd3KoT_vNlQnTGptRps5ZgnkhSnPrAwk7L98higIzSwfKoLvuu_DIpMM48dHbxckKT9waR8euJ4KSDBQ
medium: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_medium_2.png?version=v1&expires=1618512040&signature=Ue1lw5CMj7KRx6cMQL8xPeazaHCdJzWcACd1w3acuYPnWkVIpSt62OIO7hAtpAQK9xm1dhhlFj0rqRZMdRMMBA
large: https://lob-assets.com/order-creatives/ord_0d6a16a3fff6318ac8f8008dc1_comp_a20fd48ba4efda76ee827400d_thumb_large_2.png?version=v1&expires=1618512040&signature=cICc7HEm1xG_eyM4a_wtvPk2FqoLRmtgGa29kJisWnMIYBL0OkyzG4ZCYGMhp-5cZpJlSpXfTgGKh_Qmeo1TDw
merge_variables:
name:
size: 8.5x11
mail_type: usps_first_class
expected_delivery_date: "2021-03-24"
date_created: "2021-03-16T18:40:40.504Z"
date_modified: "2021-03-16T18:40:40.504Z"
send_date: "2021-03-16T18:45:40.493Z"
use_type: marketing
fsc: false
color: false
object: snap_pack
- id: ord_851100000f31bb1a872f794cee
description: April Campaign
to:
id: adr_f9228b743884ff98
description:
name: AYA
company:
phone:
email:
address_line1: 2812 PARK RD
address_line2:
address_city: CHARLOTTE
address_state: NC
address_zip: 28209-1314
address_country: UNITED STATES
metadata: {}
date_created: "2021-03-16T18:40:40.410Z"
date_modified: "2021-03-16T18:40:40.410Z"
deleted: true
object: address
from:
id: adr_210a8d4b0b76d77b
description: null
name: null
company: LOB
phone: null
email: null
address_line1: 210 KING ST STE 6100
address_line2: null
address_city: SAN FRANCISCO
address_state: CA
address_zip: 94107-1741
address_country: UNITED STATES
metadata: {}
date_created: "2018-12-08T03:01:07.651Z"
date_modified: "2018-12-08T03:01:07.651Z"
object: address
url: https://lob-assets.com/order-creatives/ord_851100000f31bb1a872f794cee_comp_a20fd48ba4efda76ee827400d.pdf?version=v1&expires=1618512040&signature=qvyCqXI1ndBvc4AjvG8FlirqLXEcfmYo4sDrRtabaXMOsX88to9G3K49uIk_aqevvZXe8HoRYD_nWydbQHqaCA
outside_template_id: tmpl_a3cb937f26d7eec
inside_template_id: tmpl_a3cb937f26d7eec
inside_template_version_id: vrsn_bfdf70893b00a85
outside_template_version_id: vrsn_bfdf70893b00a85
carrier: USPS
tracking_events: []
thumbnails:
- small: https://lob-assets.com/order-creatives/ord_851100000f31bb1a872f794cee_comp_a20fd48ba4efda76ee827400d_thumb_small_1.png?version=v1&expires=1618512040&signature=-bipeUHP-hAMcCBSrWM0ZH1VwRdSPNVGGZN9hAZKr6Lh4ly6uxvratVd5LXJCK_zOEMYk_mTWASt0ge7OY6SDA
medium: https://lob-assets.com/order-creatives/ord_851100000f31bb1a872f794cee_comp_a20fd48ba4efda76ee827400d_thumb_medium_1.png?version=v1&expires=1618512040&signature=ryxN7bsXGtw_GRFSP3Cs3A3IYjxZi3cW9BHDCNgMt6p3nobVmsc_iFHt2e-S7ndAXhhN7nP-MQVov3bt3r37BQ
large: https://lob-assets.com/order-creatives/ord_851100000f31bb1a872f794cee_comp_a20fd48ba4efda76ee827400d_thumb_large_1.png?version=v1&expires=1618512040&signature=kBrm00xkyCkJNJRHxH8HshFaebtOxnzjVWOs1VVmGMuw8H6OBNcMAMxt9s49K0jlpHoh3Nr9uSncEZMQaaNjAg
- small: https://lob-assets.com/order-creatives/ord_851100000f31bb1a872f794cee_comp_a20fd48ba4efda76ee827400d_thumb_small_2.png?version=v1&expires=1618512040&signature=3gTgU7Fd3KoT_vNlQnTGptRps5ZgnkhSnPrAwk7L98higIzSwfKoLvuu_DIpMM48dHbxckKT9waR8euJ4KSDBQ
medium: https://lob-assets.com/order-creatives/ord_851100000f31bb1a872f794cee_comp_a20fd48ba4efda76ee827400d_thumb_medium_2.png?version=v1&expires=1618512040&signature=Ue1lw5CMj7KRx6cMQL8xPeazaHCdJzWcACd1w3acuYPnWkVIpSt62OIO7hAtpAQK9xm1dhhlFj0rqRZMdRMMBA
large: https://lob-assets.com/order-creatives/ord_851100000f31bb1a872f794cee_comp_a20fd48ba4efda76ee827400d_thumb_large_2.png?version=v1&expires=1618512040&signature=cICc7HEm1xG_eyM4a_wtvPk2FqoLRmtgGa29kJisWnMIYBL0OkyzG4ZCYGMhp-5cZpJlSpXfTgGKh_Qmeo1TDw
merge_variables:
name:
size: 8.5x11
mail_type: usps_first_class
expected_delivery_date: "2021-03-24"
date_created: "2021-03-16T18:40:40.504Z"
date_modified: "2021-03-16T18:40:40.504Z"
send_date: "2021-03-16T18:45:40.493Z"
use_type: marketing
fsc: false
color: false
object: snap_pack
object: list
next_url:
previous_url:
count: 2
Loading
Loading