diff --git a/.agents/skills/ep-example-authoring/SKILL.md b/.agents/skills/ep-example-authoring/SKILL.md new file mode 100644 index 00000000..fb3e844a --- /dev/null +++ b/.agents/skills/ep-example-authoring/SKILL.md @@ -0,0 +1,138 @@ +--- +name: ep-example-authoring +description: Author or update EasyPost examples using repository conventions for directory structure, endpoint/action naming, versioning, placeholder values, and minimal runnable snippet shape across docs, guides, and responses. +--- + +# EasyPost Example Authoring Skill + +Use this skill when creating or updating examples in this repository. + +## Purpose + +Keep examples consistent across languages and versions while preserving the repo's docs-site ingestion conventions. + +## Scope + +This skill applies to: + +- `official/docs/*` +- `official/guides/*` +- `official/docs/responses/*` + +## Source Of Truth Priority + +When conventions conflict, use this order: + +1. Existing `official/docs/curl/current` endpoint/action directory and filename layout. +2. Existing `official/docs//current` precedent for that endpoint. +3. `README.md` conventions in the Development section. +4. Fixture-aligned values from `official/fixtures`. + +## Repository Structure Rules + +- `official/docs//current` is the authoritative, latest snippet set used by downstream sites. +- `official/docs//vN` directories preserve old major-version examples. +- `official/docs/responses` is not versioned and does not have a `current` directory. +- `official/guides` contains guide-specific examples and payload assets. + +## Endpoint Directory And Filename Rules + +### Docs snippets + +- Place snippets under `official/docs//current//.`. +- Endpoint directories use kebab-case path names, matching curl endpoint folder names. +- Action filenames use kebab-case and should match curl script stem. + +Examples: + +- `official/docs/curl/current/addresses/create-and-verify.sh` +- `official/docs/node/current/addresses/create-and-verify.js` +- `official/docs/python/current/scan-form/list.py` + +### Response snippets + +- Place responses under `official/docs/responses//.json`. +- Keep response endpoint/action naming aligned with curl endpoint/action naming. + +Examples: + +- `official/docs/responses/addresses/create.json` +- `official/docs/responses/rates/retrieve-stateless.json` + +## Snippet Content Rules + +Each example should be minimally viable and runnable as-is except placeholders. + +Required shape: + +1. Import the library. +2. Instantiate client with `EASYPOST_API_KEY` placeholder. +3. Perform one focused API call. +4. Print/log the result. + +Keep snippets: + +- Small and focused. +- Free of unrelated setup, abstractions, or control flow. +- Consistent with existing naming and call style in that language. + +## Placeholder Rules + +- Use `EASYPOST_API_KEY` for API key placeholder. +- Use object ID placeholders by prefix plus ellipsis, e.g. `adr_...`, `shp_...`, `sf_...`, `ca_...`. +- Use open-source/non-PII sample data. +- Prefer fixture-aligned values when possible. + +## Language-Specific Precedent Notes + +Use existing files in each language's `current` directory as direct style precedent. + +- Curl: one command per file, `curl -X ...`, JSON body inline, API key via `-u "EASYPOST_API_KEY":`. +- Node: CommonJS `require`, async IIFE, `console.log(...)` output. +- Python: module import + direct call sequence + `print(...)`. +- Ruby: `require 'easypost'`, client creation, call, `puts` output. +- PHP: instantiate client, execute call, `echo` output. +- C#: async `Main`, typed parameters object, JSON serialization to console. +- Go: helper function snippet style, make call, `fmt.Println(...)`. +- Java: class-per-file examples with `main`, but package naming may intentionally differ from folder name for historical consistency. + +Java package caution: + +- Do not auto-rename package declarations to match folder names. +- Follow existing local precedent for that endpoint set. +- Some endpoint folders intentionally map to shared package namespaces. + +## Versioning Workflow + +When a client library releases a new major version: + +1. Copy `official/docs//current` to `official/docs//v`. +2. Update only `current` for latest major syntax/usage changes. +3. Keep endpoint/action coverage and naming consistent between versions unless API/library behavior requires divergence. + +## Consistency Checklist Before Commit + +1. Filename and folder parity against curl `current` action names. +2. Response filename is action-only (no endpoint prefix). +3. Snippet uses minimal runnable structure and `EASYPOST_API_KEY`. +4. Placeholder IDs follow expected prefixes. +5. New data is non-PII and fixture-aligned where possible. +6. `current` directories remain present for all language docs. + +## Optional Verification Commands + +```bash +# Ensure required current dirs still exist +bash test/ensure-current-dirs-exist.sh + +# Spot-check endpoint/action parity shape +find official/docs/curl/current -maxdepth 2 -type f | head +find official/docs/responses -maxdepth 2 -type f | head +``` + +## Anti-Patterns + +- Endpoint-prefixed response filenames. +- Adding extra helper frameworks or architecture in simple snippets. +- Introducing language-specific style drift not already present in that language's `current` precedent. +- Changing historical version directories when the change should be only in `current`. diff --git a/README.md b/README.md index a29b657b..daebae29 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![CI](https://github.com/EasyPost/examples/workflows/CI/badge.svg)](https://github.com/EasyPost/examples/actions?query=workflow%3ACI) -5,000+ code examples for using the EasyPost API across 7+ programming languages. +3,000+ code examples for using the EasyPost API across 7+ programming languages. ## Project Structure @@ -35,13 +35,13 @@ Once installed, run an example like you would any other script or tool for that ### Conventions -When creating new doc snippets, we follow a few conventions: +When creating or updating examples, follow these baseline rules: -1. The example should be minimally viable - only include what is absolutely necessary to run the example. This ensures our example are simple, straightforward, and focused. An example is importing the lib, creating a client, calling the function with the data, printing the object to console. -2. With over 5,000 examples, it's paramount that our examples remain consistent. This is true across languages, versions (with the exception of syntax changes), and different functions. The examples have strong precedent, convention, and consistency - these should be maintained into the future. -3. When trying to determine what data to use for examples, it's probably best to use the same or similar data that our client library fixtures used during implementation. All of our client libraries use the same fixture data in tests ensuring consistency there, the same can (and should) be done for examples. - 1. You must use open source data (addresses, names, etc) - something that's not personally identifiable to a real person or business. Using EasyPost addresses or addresses of well-known public landmarks are good options -4. Examples must run "as-is" with no alterations (except for placeholder IDs and API keys). This ensures each of our examples can be quickly copy and pasted by users to try functionality quickly while they onboard, ensuring a great user experience. +1. Keep snippets minimally viable and focused: import the library, create a client, perform one clear API call, and print/log the result. +2. Preserve cross-language and cross-version consistency. Use existing `official/docs//current` snippets as precedent and keep endpoint/action naming aligned with curl. +3. Use fixture-aligned, open-source sample data only. Do not include real-person or real-business PII. +4. Examples should run as-is with no edits other than replacing placeholder API keys and object IDs. +5. For full standards (directory layout, naming, responses, placeholders, and versioning), see [`.agents/skills/ep-example-authoring/SKILL.md`](.agents/skills/ep-example-authoring/SKILL.md). ### New Major Versions @@ -49,4 +49,4 @@ When the client libraries have a new major version released, we need to create a ### Importance of `current` Directory -Our docs (and marketing) websites submodule this `examples` repo so we can pull in stable example docs at various milestones. We use the `current` language directory to pull the doc snippets during the build process (the versioned directories are then retained for reference). As such, it's imperative that the `current` directory remains the most up-to-date set of docs and present in each langauge directory we have. We have tests in this project to ensure as much. +Our docs website submodule this `examples` repo so we can pull in stable example docs at various milestones. We use the `current` language directory to pull the doc snippets during the build process (the versioned directories are then retained for reference). As such, it's imperative that the `current` directory remains the most up-to-date set of docs and present in each langauge directory we have. We have tests in this project to ensure as much. diff --git a/official/docs/responses/addresses/addresses-create-and-verify.json b/official/docs/responses/addresses/create-and-verify.json similarity index 100% rename from official/docs/responses/addresses/addresses-create-and-verify.json rename to official/docs/responses/addresses/create-and-verify.json diff --git a/official/docs/responses/addresses/addresses-create.json b/official/docs/responses/addresses/create.json similarity index 100% rename from official/docs/responses/addresses/addresses-create.json rename to official/docs/responses/addresses/create.json diff --git a/official/docs/responses/addresses/addresses-list.json b/official/docs/responses/addresses/list.json similarity index 100% rename from official/docs/responses/addresses/addresses-list.json rename to official/docs/responses/addresses/list.json diff --git a/official/docs/responses/addresses/addresses-retrieve.json b/official/docs/responses/addresses/retrieve.json similarity index 100% rename from official/docs/responses/addresses/addresses-retrieve.json rename to official/docs/responses/addresses/retrieve.json diff --git a/official/docs/responses/addresses/addresses-verify-param.json b/official/docs/responses/addresses/verify-param.json similarity index 100% rename from official/docs/responses/addresses/addresses-verify-param.json rename to official/docs/responses/addresses/verify-param.json diff --git a/official/docs/responses/addresses/addresses-verify-strict-param.json b/official/docs/responses/addresses/verify-strict-param.json similarity index 100% rename from official/docs/responses/addresses/addresses-verify-strict-param.json rename to official/docs/responses/addresses/verify-strict-param.json diff --git a/official/docs/responses/addresses/addresses-verify.json b/official/docs/responses/addresses/verify.json similarity index 100% rename from official/docs/responses/addresses/addresses-verify.json rename to official/docs/responses/addresses/verify.json diff --git a/official/docs/responses/api-keys/api-keys-create.json b/official/docs/responses/api-keys/create.json similarity index 100% rename from official/docs/responses/api-keys/api-keys-create.json rename to official/docs/responses/api-keys/create.json diff --git a/official/docs/responses/api-keys/api-keys-delete.json b/official/docs/responses/api-keys/delete.json similarity index 100% rename from official/docs/responses/api-keys/api-keys-delete.json rename to official/docs/responses/api-keys/delete.json diff --git a/official/docs/responses/api-keys/api-keys-disable.json b/official/docs/responses/api-keys/disable.json similarity index 100% rename from official/docs/responses/api-keys/api-keys-disable.json rename to official/docs/responses/api-keys/disable.json diff --git a/official/docs/responses/api-keys/api-keys-enable.json b/official/docs/responses/api-keys/enable.json similarity index 100% rename from official/docs/responses/api-keys/api-keys-enable.json rename to official/docs/responses/api-keys/enable.json diff --git a/official/docs/responses/api-keys/api-keys-retrieve.json b/official/docs/responses/api-keys/retrieve.json similarity index 100% rename from official/docs/responses/api-keys/api-keys-retrieve.json rename to official/docs/responses/api-keys/retrieve.json diff --git a/official/docs/responses/batches/batches-add-shipments.json b/official/docs/responses/batches/add-shipments.json similarity index 100% rename from official/docs/responses/batches/batches-add-shipments.json rename to official/docs/responses/batches/add-shipments.json diff --git a/official/docs/responses/batches/batches-buy.json b/official/docs/responses/batches/buy.json similarity index 100% rename from official/docs/responses/batches/batches-buy.json rename to official/docs/responses/batches/buy.json diff --git a/official/docs/responses/batches/batches-create.json b/official/docs/responses/batches/create.json similarity index 100% rename from official/docs/responses/batches/batches-create.json rename to official/docs/responses/batches/create.json diff --git a/official/docs/responses/batches/batches-label.json b/official/docs/responses/batches/label.json similarity index 100% rename from official/docs/responses/batches/batches-label.json rename to official/docs/responses/batches/label.json diff --git a/official/docs/responses/batches/batches-list.json b/official/docs/responses/batches/list.json similarity index 100% rename from official/docs/responses/batches/batches-list.json rename to official/docs/responses/batches/list.json diff --git a/official/docs/responses/batches/batches-remove-shipments.json b/official/docs/responses/batches/remove-shipments.json similarity index 100% rename from official/docs/responses/batches/batches-remove-shipments.json rename to official/docs/responses/batches/remove-shipments.json diff --git a/official/docs/responses/batches/batches-retrieve.json b/official/docs/responses/batches/retrieve.json similarity index 100% rename from official/docs/responses/batches/batches-retrieve.json rename to official/docs/responses/batches/retrieve.json diff --git a/official/docs/responses/batches/batches-scan-forms.json b/official/docs/responses/batches/scan-forms.json similarity index 100% rename from official/docs/responses/batches/batches-scan-forms.json rename to official/docs/responses/batches/scan-forms.json diff --git a/official/docs/responses/billing/billing-add-stripe-bank-account.json b/official/docs/responses/billing/add-stripe-bank-account.json similarity index 100% rename from official/docs/responses/billing/billing-add-stripe-bank-account.json rename to official/docs/responses/billing/add-stripe-bank-account.json diff --git a/official/docs/responses/billing/billing-add-stripe-credit-card.json b/official/docs/responses/billing/add-stripe-credit-card.json similarity index 100% rename from official/docs/responses/billing/billing-add-stripe-credit-card.json rename to official/docs/responses/billing/add-stripe-credit-card.json diff --git a/official/docs/responses/billing/billing-create-stripe-bank-account-secret.json b/official/docs/responses/billing/create-stripe-bank-account-secret.json similarity index 100% rename from official/docs/responses/billing/billing-create-stripe-bank-account-secret.json rename to official/docs/responses/billing/create-stripe-bank-account-secret.json diff --git a/official/docs/responses/billing/billing-create-stripe-credit-card-secret.json b/official/docs/responses/billing/create-stripe-credit-card-secret.json similarity index 100% rename from official/docs/responses/billing/billing-create-stripe-credit-card-secret.json rename to official/docs/responses/billing/create-stripe-credit-card-secret.json diff --git a/official/docs/responses/billing/billing-delete.json b/official/docs/responses/billing/delete.json similarity index 100% rename from official/docs/responses/billing/billing-delete.json rename to official/docs/responses/billing/delete.json diff --git a/official/docs/responses/billing/billing-fund.json b/official/docs/responses/billing/fund.json similarity index 100% rename from official/docs/responses/billing/billing-fund.json rename to official/docs/responses/billing/fund.json diff --git a/official/docs/responses/billing/billing-list.json b/official/docs/responses/billing/list.json similarity index 100% rename from official/docs/responses/billing/billing-list.json rename to official/docs/responses/billing/list.json diff --git a/official/docs/responses/billing/billing-retrieve-stripe-public-key.json b/official/docs/responses/billing/retrieve-stripe-public-key.json similarity index 100% rename from official/docs/responses/billing/billing-retrieve-stripe-public-key.json rename to official/docs/responses/billing/retrieve-stripe-public-key.json diff --git a/official/docs/responses/brand/brand-update.json b/official/docs/responses/brand/update.json similarity index 100% rename from official/docs/responses/brand/brand-update.json rename to official/docs/responses/brand/update.json diff --git a/official/docs/responses/carrier-accounts/carrier-accounts-create.json b/official/docs/responses/carrier-accounts/create.json similarity index 100% rename from official/docs/responses/carrier-accounts/carrier-accounts-create.json rename to official/docs/responses/carrier-accounts/create.json diff --git a/official/docs/responses/carrier-accounts/carrier-accounts-delete.json b/official/docs/responses/carrier-accounts/delete.json similarity index 100% rename from official/docs/responses/carrier-accounts/carrier-accounts-delete.json rename to official/docs/responses/carrier-accounts/delete.json diff --git a/official/docs/responses/carrier-accounts/carrier-accounts-list.json b/official/docs/responses/carrier-accounts/list.json similarity index 100% rename from official/docs/responses/carrier-accounts/carrier-accounts-list.json rename to official/docs/responses/carrier-accounts/list.json diff --git a/official/docs/responses/carrier-accounts/carrier-accounts-retrieve.json b/official/docs/responses/carrier-accounts/retrieve.json similarity index 100% rename from official/docs/responses/carrier-accounts/carrier-accounts-retrieve.json rename to official/docs/responses/carrier-accounts/retrieve.json diff --git a/official/docs/responses/carrier-accounts/carrier-accounts-update.json b/official/docs/responses/carrier-accounts/update.json similarity index 100% rename from official/docs/responses/carrier-accounts/carrier-accounts-update.json rename to official/docs/responses/carrier-accounts/update.json diff --git a/official/docs/responses/carrier-metadata/carrier-metadata-retrieve.json b/official/docs/responses/carrier-metadata/retrieve.json similarity index 100% rename from official/docs/responses/carrier-metadata/carrier-metadata-retrieve.json rename to official/docs/responses/carrier-metadata/retrieve.json diff --git a/official/docs/responses/carrier-types/carrier-types-list.json b/official/docs/responses/carrier-types/list.json similarity index 100% rename from official/docs/responses/carrier-types/carrier-types-list.json rename to official/docs/responses/carrier-types/list.json diff --git a/official/docs/responses/child-users/child-users-create.json b/official/docs/responses/child-users/create.json similarity index 100% rename from official/docs/responses/child-users/child-users-create.json rename to official/docs/responses/child-users/create.json diff --git a/official/docs/responses/child-users/child-users-delete.json b/official/docs/responses/child-users/delete.json similarity index 100% rename from official/docs/responses/child-users/child-users-delete.json rename to official/docs/responses/child-users/delete.json diff --git a/official/docs/responses/child-users/child-users-list.json b/official/docs/responses/child-users/list.json similarity index 100% rename from official/docs/responses/child-users/child-users-list.json rename to official/docs/responses/child-users/list.json diff --git a/official/docs/responses/claim/claim-cancel.json b/official/docs/responses/claim/cancel.json similarity index 100% rename from official/docs/responses/claim/claim-cancel.json rename to official/docs/responses/claim/cancel.json diff --git a/official/docs/responses/claim/claim-create.json b/official/docs/responses/claim/create.json similarity index 100% rename from official/docs/responses/claim/claim-create.json rename to official/docs/responses/claim/create.json diff --git a/official/docs/responses/claim/claim-list.json b/official/docs/responses/claim/list.json similarity index 100% rename from official/docs/responses/claim/claim-list.json rename to official/docs/responses/claim/list.json diff --git a/official/docs/responses/claim/claim-retrieve.json b/official/docs/responses/claim/retrieve.json similarity index 100% rename from official/docs/responses/claim/claim-retrieve.json rename to official/docs/responses/claim/retrieve.json diff --git a/official/docs/responses/claims/cancel.json b/official/docs/responses/claims/cancel.json new file mode 100644 index 00000000..3a57a3c2 --- /dev/null +++ b/official/docs/responses/claims/cancel.json @@ -0,0 +1,40 @@ +{ + "approved_amount": null, + "attachments": [ + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/e85d5ec7bd2f44bcbfecaddd7b8fbdc9.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/dc795c3604cb40e7a6fe37762cbff8de.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/01403d1550d44fd3a5dde2fc7e0c5314.png" + ], + "check_delivery_address": null, + "contact_email": "test@example.com", + "created_at": "2025-05-12T19:08:10Z", + "description": "Test description", + "history": [ + { + "status": "cancelled", + "status_detail": "Claim cancellation was requested.", + "timestamp": "2025-05-12T19:08:11Z" + }, + { + "status": "submitted", + "status_detail": "Claim was created.", + "timestamp": "2025-05-12T19:08:10Z" + } + ], + "id": "clm_09d81405ad494f6ca8bcbf884f207bc4", + "insurance_amount": "100.00", + "insurance_id": "ins_2f140b24c17d4e66a3223d621ef4beee", + "mode": "test", + "object": "Claim", + "payment_method": "easypost_wallet", + "recipient_name": null, + "requested_amount": "100.00", + "salvage_value": null, + "shipment_id": "shp_11f0e96492bd4e03918cb34021d49521", + "status": "cancelled", + "status_detail": "Claim cancellation was requested.", + "status_timestamp": "2025-05-12T19:08:11Z", + "tracking_code": "9405500208303109888333", + "type": "damage", + "updated_at": "2025-05-12T19:08:11Z" +} diff --git a/official/docs/responses/claims/create.json b/official/docs/responses/claims/create.json new file mode 100644 index 00000000..53bd2ae5 --- /dev/null +++ b/official/docs/responses/claims/create.json @@ -0,0 +1,35 @@ +{ + "approved_amount": null, + "attachments": [ + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/a915d0e238074fff9729afa1bfb87a0e.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/3020f31a57374dc3ace477f7a4ec860d.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/88aada9e505f4e77bd6060710d78e497.png" + ], + "check_delivery_address": null, + "contact_email": "test@example.com", + "created_at": "2025-05-12T19:08:04Z", + "description": "Test description", + "history": [ + { + "status": "submitted", + "status_detail": "Claim was created.", + "timestamp": "2025-05-12T19:08:04Z" + } + ], + "id": "clm_09d89e88a0c943d59018bc26b041c41c", + "insurance_amount": "100.00", + "insurance_id": "ins_da31156b6335407da23ee06fa2fe8a28", + "mode": "test", + "object": "Claim", + "payment_method": "easypost_wallet", + "recipient_name": null, + "requested_amount": "100.00", + "salvage_value": null, + "shipment_id": "shp_531f76e4a4de491183f5cabb738cb828", + "status": "submitted", + "status_detail": "Claim was created.", + "status_timestamp": "2025-05-12T19:08:04Z", + "tracking_code": "9405500208303109888319", + "type": "damage", + "updated_at": "2025-05-12T19:08:04Z" +} diff --git a/official/docs/responses/claims/list.json b/official/docs/responses/claims/list.json new file mode 100644 index 00000000..e59fa6a3 --- /dev/null +++ b/official/docs/responses/claims/list.json @@ -0,0 +1,40 @@ +{ + "claims": [ + { + "approved_amount": null, + "attachments": [ + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/2384384e13a14d2eb6513b6f4fa3e7db.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/695260b95d0743a284bf0bf1eea7421c.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/f369b8e2ce894e798c14850684fd16fe.png" + ], + "check_delivery_address": null, + "contact_email": "test@example.com", + "created_at": "2025-05-12T19:08:07Z", + "description": "Test description", + "history": [ + { + "status": "submitted", + "status_detail": "Claim was created.", + "timestamp": "2025-05-12T19:08:07Z" + } + ], + "id": "clm_09d891bf4d9045b48cb64e0319338f1c", + "insurance_amount": "100.00", + "insurance_id": "ins_e5d632db2ede497e83de78e0c6cc5a60", + "mode": "test", + "object": "Claim", + "payment_method": "easypost_wallet", + "recipient_name": null, + "requested_amount": "100.00", + "salvage_value": null, + "shipment_id": "shp_1152edb694924af2a5ca3c5d4fba45d3", + "status": "submitted", + "status_detail": "Claim was created.", + "status_timestamp": "2025-05-12T19:08:07Z", + "tracking_code": "9405500208303109888326", + "type": "damage", + "updated_at": "2025-05-12T19:08:07Z" + } + ], + "has_more": true +} diff --git a/official/docs/responses/claims/retrieve.json b/official/docs/responses/claims/retrieve.json new file mode 100644 index 00000000..807a9238 --- /dev/null +++ b/official/docs/responses/claims/retrieve.json @@ -0,0 +1,35 @@ +{ + "approved_amount": null, + "attachments": [ + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/2384384e13a14d2eb6513b6f4fa3e7db.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/695260b95d0743a284bf0bf1eea7421c.png", + "https://easypost-files.s3-us-west-2.amazonaws.com/insurance/20250512/f369b8e2ce894e798c14850684fd16fe.png" + ], + "check_delivery_address": null, + "contact_email": "test@example.com", + "created_at": "2025-05-12T19:08:07Z", + "description": "Test description", + "history": [ + { + "status": "submitted", + "status_detail": "Claim was created.", + "timestamp": "2025-05-12T19:08:07Z" + } + ], + "id": "clm_09d891bf4d9045b48cb64e0319338f1c", + "insurance_amount": "100.00", + "insurance_id": "ins_e5d632db2ede497e83de78e0c6cc5a60", + "mode": "test", + "object": "Claim", + "payment_method": "easypost_wallet", + "recipient_name": null, + "requested_amount": "100.00", + "salvage_value": null, + "shipment_id": "shp_1152edb694924af2a5ca3c5d4fba45d3", + "status": "submitted", + "status_detail": "Claim was created.", + "status_timestamp": "2025-05-12T19:08:07Z", + "tracking_code": "9405500208303109888326", + "type": "damage", + "updated_at": "2025-05-12T19:08:07Z" +} diff --git a/official/docs/responses/customer-portals/customer-portal-create.json b/official/docs/responses/customer-portals/create.json similarity index 100% rename from official/docs/responses/customer-portals/customer-portal-create.json rename to official/docs/responses/customer-portals/create.json diff --git a/official/docs/responses/customs-infos/customs-infos-create.json b/official/docs/responses/customs-infos/create.json similarity index 100% rename from official/docs/responses/customs-infos/customs-infos-create.json rename to official/docs/responses/customs-infos/create.json diff --git a/official/docs/responses/customs-infos/customs-infos-retrieve.json b/official/docs/responses/customs-infos/retrieve.json similarity index 100% rename from official/docs/responses/customs-infos/customs-infos-retrieve.json rename to official/docs/responses/customs-infos/retrieve.json diff --git a/official/docs/responses/customs-items/customs-items-create.json b/official/docs/responses/customs-items/create.json similarity index 100% rename from official/docs/responses/customs-items/customs-items-create.json rename to official/docs/responses/customs-items/create.json diff --git a/official/docs/responses/customs-items/customs-items-retrieve.json b/official/docs/responses/customs-items/retrieve.json similarity index 100% rename from official/docs/responses/customs-items/customs-items-retrieve.json rename to official/docs/responses/customs-items/retrieve.json diff --git a/official/docs/responses/endshipper/endshipper-buy.json b/official/docs/responses/endshipper/buy.json similarity index 100% rename from official/docs/responses/endshipper/endshipper-buy.json rename to official/docs/responses/endshipper/buy.json diff --git a/official/docs/responses/endshipper/endshipper-create.json b/official/docs/responses/endshipper/create.json similarity index 100% rename from official/docs/responses/endshipper/endshipper-create.json rename to official/docs/responses/endshipper/create.json diff --git a/official/docs/responses/endshipper/endshipper-list.json b/official/docs/responses/endshipper/list.json similarity index 100% rename from official/docs/responses/endshipper/endshipper-list.json rename to official/docs/responses/endshipper/list.json diff --git a/official/docs/responses/endshipper/endshipper-retrieve.json b/official/docs/responses/endshipper/retrieve.json similarity index 100% rename from official/docs/responses/endshipper/endshipper-retrieve.json rename to official/docs/responses/endshipper/retrieve.json diff --git a/official/docs/responses/endshipper/endshipper-update.json b/official/docs/responses/endshipper/update.json similarity index 100% rename from official/docs/responses/endshipper/endshipper-update.json rename to official/docs/responses/endshipper/update.json diff --git a/official/docs/responses/events/events-list.json b/official/docs/responses/events/list.json similarity index 100% rename from official/docs/responses/events/events-list.json rename to official/docs/responses/events/list.json diff --git a/official/docs/responses/events/events-retrieve.json b/official/docs/responses/events/retrieve.json similarity index 100% rename from official/docs/responses/events/events-retrieve.json rename to official/docs/responses/events/retrieve.json diff --git a/official/docs/responses/forms/forms-create.json b/official/docs/responses/forms/create.json similarity index 100% rename from official/docs/responses/forms/forms-create.json rename to official/docs/responses/forms/create.json diff --git a/official/docs/responses/insurance/insurance-create.json b/official/docs/responses/insurance/create.json similarity index 100% rename from official/docs/responses/insurance/insurance-create.json rename to official/docs/responses/insurance/create.json diff --git a/official/docs/responses/insurance/insurance-list.json b/official/docs/responses/insurance/list.json similarity index 100% rename from official/docs/responses/insurance/insurance-list.json rename to official/docs/responses/insurance/list.json diff --git a/official/docs/responses/insurance/insurance-refund.json b/official/docs/responses/insurance/refund.json similarity index 100% rename from official/docs/responses/insurance/insurance-refund.json rename to official/docs/responses/insurance/refund.json diff --git a/official/docs/responses/insurance/insurance-retrieve.json b/official/docs/responses/insurance/retrieve.json similarity index 100% rename from official/docs/responses/insurance/insurance-retrieve.json rename to official/docs/responses/insurance/retrieve.json diff --git a/official/docs/responses/luma/luma-buy.json b/official/docs/responses/luma/buy.json similarity index 100% rename from official/docs/responses/luma/luma-buy.json rename to official/docs/responses/luma/buy.json diff --git a/official/docs/responses/luma/luma-info.json b/official/docs/responses/luma/info.json similarity index 100% rename from official/docs/responses/luma/luma-info.json rename to official/docs/responses/luma/info.json diff --git a/official/docs/responses/luma/luma-one-call-buy.json b/official/docs/responses/luma/one-call-buy.json similarity index 100% rename from official/docs/responses/luma/luma-one-call-buy.json rename to official/docs/responses/luma/one-call-buy.json diff --git a/official/docs/responses/luma/promise.json b/official/docs/responses/luma/promise.json new file mode 100644 index 00000000..57d841b3 --- /dev/null +++ b/official/docs/responses/luma/promise.json @@ -0,0 +1,143 @@ +{ + "luma_info": { + "ai_results": [ + { + "carrier": "USPS", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-11", + "predicted_deliver_days": 5, + "rate_id": "rate_878246b64dfc4acdaae144632071ebbf", + "rate_usd": "135.45", + "service": "Express" + }, + { + "carrier": "USPS", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-12", + "predicted_deliver_days": 6, + "rate_id": "rate_c5ea42853ee34db5a3b739a30c1d1e7d", + "rate_usd": "41.44", + "service": "Priority" + }, + { + "carrier": "USPS", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-13", + "predicted_deliver_days": 7, + "rate_id": "rate_3041c849fcfb4eca8e7140ce8ac68ac2", + "rate_usd": "23.85", + "service": "GroundAdvantage" + }, + { + "carrier": "UPSDAP", + "meets_ruleset_requirements": true, + "predicted_deliver_by_date": "2025-02-07", + "predicted_deliver_days": 1, + "rate_id": "rate_ecc1a08e97e349dc83645663e02e8ce6", + "rate_usd": "94.45", + "service": "NextDayAir" + }, + { + "carrier": "UPSDAP", + "meets_ruleset_requirements": true, + "predicted_deliver_by_date": "2025-02-10", + "predicted_deliver_days": 4, + "rate_id": "rate_9de47a58578943f692779ba1ef649db0", + "rate_usd": "124.45", + "service": "NextDayAirEarlyAM" + }, + { + "carrier": "UPSDAP", + "meets_ruleset_requirements": true, + "predicted_deliver_by_date": "2025-02-10", + "predicted_deliver_days": 4, + "rate_id": "rate_3a017a1f045a44088baba60cacaacae4", + "rate_usd": "87.91", + "service": "NextDayAirSaver" + }, + { + "carrier": "UPSDAP", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-11", + "predicted_deliver_days": 5, + "rate_id": "rate_5c552ee17b764ebe8b3e040e23acc161", + "rate_usd": "52.98", + "service": "2ndDayAir" + }, + { + "carrier": "UPSDAP", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-11", + "predicted_deliver_days": 5, + "rate_id": "rate_00697bb80a6a4690a4adc1fa821d0549", + "rate_usd": "60.79", + "service": "2ndDayAirAM" + }, + { + "carrier": "UPSDAP", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-12", + "predicted_deliver_days": 6, + "rate_id": "rate_8d6d3b28b62d43e8bf137f7f63588807", + "rate_usd": "38.19", + "service": "3DaySelect" + }, + { + "carrier": "UPSDAP", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-14", + "predicted_deliver_days": 8, + "rate_id": "rate_ec4000010aa74083bcf7af34d77cd69f", + "rate_usd": "24.02", + "service": "Ground" + }, + { + "carrier": "FedExDefault", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-15", + "predicted_deliver_days": 9, + "rate_id": "rate_81be930fa6824faa9f75ce474db8c329", + "rate_usd": "47.99", + "service": "SMART_POST" + }, + { + "carrier": "FedExDefault", + "meets_ruleset_requirements": true, + "predicted_deliver_by_date": "2025-02-10", + "predicted_deliver_days": 4, + "rate_id": "rate_8c590b2c9f9f42fa8986b19e0180d5bd", + "rate_usd": "289.00", + "service": "PRIORITY_OVERNIGHT" + }, + { + "carrier": "FedExDefault", + "meets_ruleset_requirements": true, + "predicted_deliver_by_date": "2025-02-10", + "predicted_deliver_days": 4, + "rate_id": "rate_f6cba61f30714f7fb779b7b157c0c619", + "rate_usd": "264.87", + "service": "STANDARD_OVERNIGHT" + }, + { + "carrier": "FedExDefault", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-11", + "predicted_deliver_days": 5, + "rate_id": "rate_9a64fd048d644d8daaece83c92b49ae8", + "rate_usd": "202.16", + "service": "FEDEX_2_DAY_AM" + }, + { + "carrier": "FedExDefault", + "meets_ruleset_requirements": false, + "predicted_deliver_by_date": "2025-02-13", + "predicted_deliver_days": 7, + "rate_id": "rate_4fb6b986d5e242b39dcfd47bff29b74d", + "rate_usd": "36.75", + "service": "FEDEX_GROUND" + } + ], + "matching_rule_idx": 0, + "ruleset_description": "Buy the cheapest rate that satisfies all of the following:\nRule 0\n - Deliver by user input day of deliver_by_date - Transit day confidence >= 90\nOtherwise buy the cheapest rate" + } +} diff --git a/official/docs/responses/options/options-create-with-options.json b/official/docs/responses/options/create-with-options.json similarity index 100% rename from official/docs/responses/options/options-create-with-options.json rename to official/docs/responses/options/create-with-options.json diff --git a/official/docs/responses/orders/orders-buy.json b/official/docs/responses/orders/buy.json similarity index 100% rename from official/docs/responses/orders/orders-buy.json rename to official/docs/responses/orders/buy.json diff --git a/official/docs/responses/orders/orders-create.json b/official/docs/responses/orders/create.json similarity index 100% rename from official/docs/responses/orders/orders-create.json rename to official/docs/responses/orders/create.json diff --git a/official/docs/responses/orders/orders-one-call-buy.json b/official/docs/responses/orders/one-call-buy.json similarity index 100% rename from official/docs/responses/orders/orders-one-call-buy.json rename to official/docs/responses/orders/one-call-buy.json diff --git a/official/docs/responses/orders/orders-retrieve.json b/official/docs/responses/orders/retrieve.json similarity index 100% rename from official/docs/responses/orders/orders-retrieve.json rename to official/docs/responses/orders/retrieve.json diff --git a/official/docs/responses/pagination/pagination-get-next-page.json b/official/docs/responses/pagination/get-next-page.json similarity index 100% rename from official/docs/responses/pagination/pagination-get-next-page.json rename to official/docs/responses/pagination/get-next-page.json diff --git a/official/docs/responses/parcels/parcels-create.json b/official/docs/responses/parcels/create.json similarity index 100% rename from official/docs/responses/parcels/parcels-create.json rename to official/docs/responses/parcels/create.json diff --git a/official/docs/responses/parcels/parcels-retrieve.json b/official/docs/responses/parcels/retrieve.json similarity index 100% rename from official/docs/responses/parcels/parcels-retrieve.json rename to official/docs/responses/parcels/retrieve.json diff --git a/official/docs/responses/payloads/payloads-list.json b/official/docs/responses/payloads/list.json similarity index 100% rename from official/docs/responses/payloads/payloads-list.json rename to official/docs/responses/payloads/list.json diff --git a/official/docs/responses/payloads/payloads-retrieve.json b/official/docs/responses/payloads/retrieve.json similarity index 100% rename from official/docs/responses/payloads/payloads-retrieve.json rename to official/docs/responses/payloads/retrieve.json diff --git a/official/docs/responses/pickups/pickups-buy.json b/official/docs/responses/pickups/buy.json similarity index 100% rename from official/docs/responses/pickups/pickups-buy.json rename to official/docs/responses/pickups/buy.json diff --git a/official/docs/responses/pickups/pickups-cancel.json b/official/docs/responses/pickups/cancel.json similarity index 100% rename from official/docs/responses/pickups/pickups-cancel.json rename to official/docs/responses/pickups/cancel.json diff --git a/official/docs/responses/pickups/pickups-create.json b/official/docs/responses/pickups/create.json similarity index 100% rename from official/docs/responses/pickups/pickups-create.json rename to official/docs/responses/pickups/create.json diff --git a/official/docs/responses/pickups/pickups-list.json b/official/docs/responses/pickups/list.json similarity index 100% rename from official/docs/responses/pickups/pickups-list.json rename to official/docs/responses/pickups/list.json diff --git a/official/docs/responses/pickups/pickups-retrieve.json b/official/docs/responses/pickups/retrieve.json similarity index 100% rename from official/docs/responses/pickups/pickups-retrieve.json rename to official/docs/responses/pickups/retrieve.json diff --git a/official/docs/responses/rates/rates-regenerate.json b/official/docs/responses/rates/regenerate.json similarity index 100% rename from official/docs/responses/rates/rates-regenerate.json rename to official/docs/responses/rates/regenerate.json diff --git a/official/docs/responses/rates/rates-retrieve-stateless.json b/official/docs/responses/rates/retrieve-stateless.json similarity index 100% rename from official/docs/responses/rates/rates-retrieve-stateless.json rename to official/docs/responses/rates/retrieve-stateless.json diff --git a/official/docs/responses/rates/rates-retrieve.json b/official/docs/responses/rates/retrieve.json similarity index 100% rename from official/docs/responses/rates/rates-retrieve.json rename to official/docs/responses/rates/retrieve.json diff --git a/official/docs/responses/readydocs/readydocs-create.json b/official/docs/responses/readydocs/create.json similarity index 100% rename from official/docs/responses/readydocs/readydocs-create.json rename to official/docs/responses/readydocs/create.json diff --git a/official/docs/responses/referral-customers/referral-customers-add-payment-method-with-bank-account.json b/official/docs/responses/referral-customers/add-payment-method-with-bank-account.json similarity index 100% rename from official/docs/responses/referral-customers/referral-customers-add-payment-method-with-bank-account.json rename to official/docs/responses/referral-customers/add-payment-method-with-bank-account.json diff --git a/official/docs/responses/referral-customers/referral-customers-add-payment-method-with-credit-card.json b/official/docs/responses/referral-customers/add-payment-method-with-credit-card.json similarity index 100% rename from official/docs/responses/referral-customers/referral-customers-add-payment-method-with-credit-card.json rename to official/docs/responses/referral-customers/add-payment-method-with-credit-card.json diff --git a/official/docs/responses/referral-customers/referral-customers-create.json b/official/docs/responses/referral-customers/create.json similarity index 100% rename from official/docs/responses/referral-customers/referral-customers-create.json rename to official/docs/responses/referral-customers/create.json diff --git a/official/docs/responses/referral-customers/referral-customers-list.json b/official/docs/responses/referral-customers/list.json similarity index 100% rename from official/docs/responses/referral-customers/referral-customers-list.json rename to official/docs/responses/referral-customers/list.json diff --git a/official/docs/responses/referral-customers/referral-customers-refund-by-amount.json b/official/docs/responses/referral-customers/refund-by-amount.json similarity index 100% rename from official/docs/responses/referral-customers/referral-customers-refund-by-amount.json rename to official/docs/responses/referral-customers/refund-by-amount.json diff --git a/official/docs/responses/referral-customers/referral-customers-refund-by-payment-log.json b/official/docs/responses/referral-customers/refund-by-payment-log.json similarity index 100% rename from official/docs/responses/referral-customers/referral-customers-refund-by-payment-log.json rename to official/docs/responses/referral-customers/refund-by-payment-log.json diff --git a/official/docs/responses/referral-customers/referral-customers-update.json b/official/docs/responses/referral-customers/update.json similarity index 100% rename from official/docs/responses/referral-customers/referral-customers-update.json rename to official/docs/responses/referral-customers/update.json diff --git a/official/docs/responses/refunds/refunds-create.json b/official/docs/responses/refunds/create.json similarity index 100% rename from official/docs/responses/refunds/refunds-create.json rename to official/docs/responses/refunds/create.json diff --git a/official/docs/responses/refunds/refunds-list.json b/official/docs/responses/refunds/list.json similarity index 100% rename from official/docs/responses/refunds/refunds-list.json rename to official/docs/responses/refunds/list.json diff --git a/official/docs/responses/refunds/refunds-retrieve.json b/official/docs/responses/refunds/retrieve.json similarity index 100% rename from official/docs/responses/refunds/refunds-retrieve.json rename to official/docs/responses/refunds/retrieve.json diff --git a/official/docs/responses/reports/reports-create.json b/official/docs/responses/reports/create.json similarity index 100% rename from official/docs/responses/reports/reports-create.json rename to official/docs/responses/reports/create.json diff --git a/official/docs/responses/reports/reports-list.json b/official/docs/responses/reports/list.json similarity index 100% rename from official/docs/responses/reports/reports-list.json rename to official/docs/responses/reports/list.json diff --git a/official/docs/responses/reports/reports-retrieve.json b/official/docs/responses/reports/retrieve.json similarity index 100% rename from official/docs/responses/reports/reports-retrieve.json rename to official/docs/responses/reports/retrieve.json diff --git a/official/docs/responses/returns/returns-create.json b/official/docs/responses/returns/create.json similarity index 100% rename from official/docs/responses/returns/returns-create.json rename to official/docs/responses/returns/create.json diff --git a/official/docs/responses/scan-form/scan-form-create.json b/official/docs/responses/scan-form/create.json similarity index 100% rename from official/docs/responses/scan-form/scan-form-create.json rename to official/docs/responses/scan-form/create.json diff --git a/official/docs/responses/scan-form/scan-form-list.json b/official/docs/responses/scan-form/list.json similarity index 100% rename from official/docs/responses/scan-form/scan-form-list.json rename to official/docs/responses/scan-form/list.json diff --git a/official/docs/responses/scan-form/scan-form-retrieve.json b/official/docs/responses/scan-form/retrieve.json similarity index 100% rename from official/docs/responses/scan-form/scan-form-retrieve.json rename to official/docs/responses/scan-form/retrieve.json diff --git a/official/docs/responses/shipments/shipments-buy.json b/official/docs/responses/shipments/buy.json similarity index 100% rename from official/docs/responses/shipments/shipments-buy.json rename to official/docs/responses/shipments/buy.json diff --git a/official/docs/responses/shipments/shipments-create.json b/official/docs/responses/shipments/create.json similarity index 100% rename from official/docs/responses/shipments/shipments-create.json rename to official/docs/responses/shipments/create.json diff --git a/official/docs/responses/shipments/shipments-label.json b/official/docs/responses/shipments/label.json similarity index 100% rename from official/docs/responses/shipments/shipments-label.json rename to official/docs/responses/shipments/label.json diff --git a/official/docs/responses/shipments/shipments-list.json b/official/docs/responses/shipments/list.json similarity index 100% rename from official/docs/responses/shipments/shipments-list.json rename to official/docs/responses/shipments/list.json diff --git a/official/docs/responses/shipments/shipments-one-call-buy.json b/official/docs/responses/shipments/one-call-buy.json similarity index 100% rename from official/docs/responses/shipments/shipments-one-call-buy.json rename to official/docs/responses/shipments/one-call-buy.json diff --git a/official/docs/responses/shipments/shipments-retrieve.json b/official/docs/responses/shipments/retrieve.json similarity index 100% rename from official/docs/responses/shipments/shipments-retrieve.json rename to official/docs/responses/shipments/retrieve.json diff --git a/official/docs/responses/shipping-insurance/shipping-insurance-insure.json b/official/docs/responses/shipping-insurance/insure.json similarity index 100% rename from official/docs/responses/shipping-insurance/shipping-insurance-insure.json rename to official/docs/responses/shipping-insurance/insure.json diff --git a/official/docs/responses/shipping-refund/shipping-refund-refund.json b/official/docs/responses/shipping-refund/refund.json similarity index 100% rename from official/docs/responses/shipping-refund/shipping-refund-refund.json rename to official/docs/responses/shipping-refund/refund.json diff --git a/official/docs/responses/smartrate/smartrate-retrieve-estimated-delivery-date.json b/official/docs/responses/smartrate/retrieve-estimated-delivery-date.json similarity index 100% rename from official/docs/responses/smartrate/smartrate-retrieve-estimated-delivery-date.json rename to official/docs/responses/smartrate/retrieve-estimated-delivery-date.json diff --git a/official/docs/responses/smartrate/smartrate-retrieve-recommend-ship-date.json b/official/docs/responses/smartrate/retrieve-recommend-ship-date.json similarity index 100% rename from official/docs/responses/smartrate/smartrate-retrieve-recommend-ship-date.json rename to official/docs/responses/smartrate/retrieve-recommend-ship-date.json diff --git a/official/docs/responses/smartrate/smartrate-retrieve-standalone-smartrate-deliver-by.json b/official/docs/responses/smartrate/retrieve-standalone-smartrate-deliver-by.json similarity index 100% rename from official/docs/responses/smartrate/smartrate-retrieve-standalone-smartrate-deliver-by.json rename to official/docs/responses/smartrate/retrieve-standalone-smartrate-deliver-by.json diff --git a/official/docs/responses/smartrate/smartrate-retrieve-standalone-smartrate-deliver-on.json b/official/docs/responses/smartrate/retrieve-standalone-smartrate-deliver-on.json similarity index 100% rename from official/docs/responses/smartrate/smartrate-retrieve-standalone-smartrate-deliver-on.json rename to official/docs/responses/smartrate/retrieve-standalone-smartrate-deliver-on.json diff --git a/official/docs/responses/smartrate/smartrate-retrieve-time-in-transit-statistics.json b/official/docs/responses/smartrate/retrieve-time-in-transit-statistics.json similarity index 100% rename from official/docs/responses/smartrate/smartrate-retrieve-time-in-transit-statistics.json rename to official/docs/responses/smartrate/retrieve-time-in-transit-statistics.json diff --git a/official/docs/responses/tax-identifiers/tax-identifiers-create.json b/official/docs/responses/tax-identifiers/create.json similarity index 100% rename from official/docs/responses/tax-identifiers/tax-identifiers-create.json rename to official/docs/responses/tax-identifiers/create.json diff --git a/official/docs/responses/trackers/trackers-create.json b/official/docs/responses/trackers/create.json similarity index 100% rename from official/docs/responses/trackers/trackers-create.json rename to official/docs/responses/trackers/create.json diff --git a/official/docs/responses/trackers/trackers-delete.json b/official/docs/responses/trackers/delete.json similarity index 100% rename from official/docs/responses/trackers/trackers-delete.json rename to official/docs/responses/trackers/delete.json diff --git a/official/docs/responses/trackers/trackers-list.json b/official/docs/responses/trackers/list.json similarity index 100% rename from official/docs/responses/trackers/trackers-list.json rename to official/docs/responses/trackers/list.json diff --git a/official/docs/responses/trackers/trackers-retrieve.json b/official/docs/responses/trackers/retrieve.json similarity index 100% rename from official/docs/responses/trackers/trackers-retrieve.json rename to official/docs/responses/trackers/retrieve.json diff --git a/official/docs/responses/users/users-retrieve.json b/official/docs/responses/users/retrieve.json similarity index 100% rename from official/docs/responses/users/users-retrieve.json rename to official/docs/responses/users/retrieve.json diff --git a/official/docs/responses/users/users-update.json b/official/docs/responses/users/update.json similarity index 100% rename from official/docs/responses/users/users-update.json rename to official/docs/responses/users/update.json diff --git a/official/docs/responses/webhooks/webhooks-create.json b/official/docs/responses/webhooks/create.json similarity index 100% rename from official/docs/responses/webhooks/webhooks-create.json rename to official/docs/responses/webhooks/create.json diff --git a/official/docs/responses/webhooks/webhooks-delete.json b/official/docs/responses/webhooks/delete.json similarity index 100% rename from official/docs/responses/webhooks/webhooks-delete.json rename to official/docs/responses/webhooks/delete.json diff --git a/official/docs/responses/webhooks/webhooks-list.json b/official/docs/responses/webhooks/list.json similarity index 100% rename from official/docs/responses/webhooks/webhooks-list.json rename to official/docs/responses/webhooks/list.json diff --git a/official/docs/responses/webhooks/webhooks-retrieve.json b/official/docs/responses/webhooks/retrieve.json similarity index 100% rename from official/docs/responses/webhooks/webhooks-retrieve.json rename to official/docs/responses/webhooks/retrieve.json diff --git a/official/docs/responses/webhooks/webhooks-update.json b/official/docs/responses/webhooks/update.json similarity index 100% rename from official/docs/responses/webhooks/webhooks-update.json rename to official/docs/responses/webhooks/update.json