zippendo 1.3.12 → 1.3.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +6 -0
- data/SECURITY.md +19 -0
- data/lib/zippendo/version.rb +1 -1
- data/zippendo.gemspec +4 -4
- metadata +8 -35
- data/git_push.sh +0 -57
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 998d55654486759587238e2a534d6d7b818b2a4eeb6b55c8a81a039b8388e8dd
|
|
4
|
+
data.tar.gz: 8d19eb03747d5d33be9d843150eac200a0c953a8d01949756c4f2cb56ebcc5c3
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6d130e2d53c5d80773c2e7f0a8dab45474ef1c561d2fd351dac9de5318dd102f9ecb18e772914c267d42fc9aac1a89c70f49e7fabc8325be586ea2e27b0083f1
|
|
7
|
+
data.tar.gz: a64671dc180e1f8fa2d7eda263c7324218c22664386083f5278edbd14d92ff5dfc280a1c03910c58203e83085aadb913dd4b800b84c5a410410e4d45302a8bcf
|
data/README.md
CHANGED
|
@@ -3,6 +3,12 @@
|
|
|
3
3
|
Official Ruby client for the [Zippendo](https://zippendo.com) shipping & logistics API. Requires
|
|
4
4
|
Ruby 2.7+.
|
|
5
5
|
|
|
6
|
+
Book shipments and print labels with PostNord, GLS, DAO, Bring, DHL, DPD, UPS and more, track
|
|
7
|
+
parcels, and manage orders, shipping rules and webhooks from your own code. New to the API? Start with
|
|
8
|
+
the [SDK guide](https://www.zippendo.com/docs/sdks/overview) or browse the
|
|
9
|
+
[API reference](https://www.zippendo.com/docs/api-reference/overview). To work from an AI assistant
|
|
10
|
+
instead, connect the [Zippendo MCP server](https://www.zippendo.com/docs/mcp/overview).
|
|
11
|
+
|
|
6
12
|
## Install
|
|
7
13
|
|
|
8
14
|
```sh
|
data/SECURITY.md
ADDED
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
# Security policy
|
|
2
|
+
|
|
3
|
+
## Reporting a vulnerability
|
|
4
|
+
|
|
5
|
+
Please report a security issue privately by email to **support@zippendo.com** with "Security" in the
|
|
6
|
+
subject, not in a public issue. Include the SDK, its version and the steps to reproduce. This covers
|
|
7
|
+
this SDK and the Zippendo API it calls.
|
|
8
|
+
|
|
9
|
+
## Supported versions
|
|
10
|
+
|
|
11
|
+
Fixes ship in a new release; earlier versions are not patched. Every Zippendo SDK is released under
|
|
12
|
+
the same version number, so a fix reaches all of them at once.
|
|
13
|
+
|
|
14
|
+
## Where this code comes from
|
|
15
|
+
|
|
16
|
+
This repository is generated from the Zippendo public API specification
|
|
17
|
+
(<https://api.zippendo.com/public/json>) with [OpenAPI Generator](https://openapi-generator.tech) and
|
|
18
|
+
published by Zippendo's release pipeline. A change made here directly is replaced by the next release,
|
|
19
|
+
so report problems in an issue or by email rather than a pull request.
|
data/lib/zippendo/version.rb
CHANGED
data/zippendo.gemspec
CHANGED
|
@@ -19,11 +19,11 @@ Gem::Specification.new do |s|
|
|
|
19
19
|
s.name = "zippendo"
|
|
20
20
|
s.version = Zippendo::VERSION
|
|
21
21
|
s.platform = Gem::Platform::RUBY
|
|
22
|
-
s.authors = ["
|
|
22
|
+
s.authors = ["Zippendo"]
|
|
23
23
|
s.email = ["support@zippendo.com"]
|
|
24
|
-
s.homepage = "https://www.zippendo.com"
|
|
25
|
-
s.summary = "Zippendo
|
|
26
|
-
s.description = "
|
|
24
|
+
s.homepage = "https://www.zippendo.com/docs/sdks/overview"
|
|
25
|
+
s.summary = "Official Ruby SDK for the Zippendo shipping API: book shipments, print labels and track parcels with PostNord, GLS, DAO, Bring, DHL, DPD, UPS and more."
|
|
26
|
+
s.description = "Official Ruby SDK for the Zippendo shipping API: book shipments, print labels and track parcels with PostNord, GLS, DAO, Bring, DHL, DPD, UPS and more."
|
|
27
27
|
s.license = "MIT"
|
|
28
28
|
s.required_ruby_version = ">= 2.7"
|
|
29
29
|
s.metadata = {}
|
metadata
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: zippendo
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 1.3.
|
|
4
|
+
version: 1.3.14
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
|
-
-
|
|
7
|
+
- Zippendo
|
|
8
8
|
bindir: bin
|
|
9
9
|
cert_chain: []
|
|
10
10
|
date: 1980-01-02 00:00:00.000000000 Z
|
|
@@ -49,36 +49,8 @@ dependencies:
|
|
|
49
49
|
- - ">="
|
|
50
50
|
- !ruby/object:Gem::Version
|
|
51
51
|
version: 3.6.0
|
|
52
|
-
description: '
|
|
53
|
-
|
|
54
|
-
can be split into brands, each keeping its own orders, shipments and configuration
|
|
55
|
-
separate. There are two ways to scope requests to one brand, and NEITHER changes
|
|
56
|
-
any request body: 1. **Bind the token.** Create an API token with a `brandId` and
|
|
57
|
-
every request it makes is confined to that brand — reads filtered, writes stamped.
|
|
58
|
-
This is the recommended way to give a single brand''s team its own credential.
|
|
59
|
-
2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope
|
|
60
|
-
an individual request by sending the brand''s id or slug in this header. Most
|
|
61
|
-
SDKs let you set it once on the client so every call inherits it. A brand-bound
|
|
62
|
-
token that receives an `X-Zippendo-Brand` header naming a different brand is rejected
|
|
63
|
-
with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests
|
|
64
|
-
cover the whole organization, which is the behaviour of every existing token. Records
|
|
65
|
-
that belong to no brand carry `brandId: null`. Configuration (carriers, shipping
|
|
66
|
-
rules, addresses) with a null brand is organization-wide and remains visible inside
|
|
67
|
-
every brand; orders and shipments with a null brand are only visible organization-wide. List
|
|
68
|
-
endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow
|
|
69
|
-
further within whichever brand context already applies. `own` returns only rows
|
|
70
|
-
assigned to that brand, and requires a brand context — a brand-bound token, a resolved
|
|
71
|
-
brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared`
|
|
72
|
-
returns only the organization-wide rows (equivalent to filtering `brandId=none`).
|
|
73
|
-
The default, `both`, keeps the existing behaviour: a brand context sees its own
|
|
74
|
-
rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default
|
|
75
|
-
to apply the same choice to every request instead of repeating the query parameter
|
|
76
|
-
on each call — an explicit `brandScope` query parameter always wins over the header,
|
|
77
|
-
and a blank header value is ignored. Brands themselves are managed under the **Brands**
|
|
78
|
-
tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive`
|
|
79
|
-
— permanent deletion is a dashboard-only action, since it is refused while any order,
|
|
80
|
-
shipment, member or token still references the brand. Brands require a plan that
|
|
81
|
-
includes them; creating one beyond your plan''s limit returns `403`.'
|
|
52
|
+
description: 'Official Ruby SDK for the Zippendo shipping API: book shipments, print
|
|
53
|
+
labels and track parcels with PostNord, GLS, DAO, Bring, DHL, DPD, UPS and more.'
|
|
82
54
|
email:
|
|
83
55
|
- support@zippendo.com
|
|
84
56
|
executables: []
|
|
@@ -89,6 +61,7 @@ files:
|
|
|
89
61
|
- LICENSE.md
|
|
90
62
|
- README.md
|
|
91
63
|
- Rakefile
|
|
64
|
+
- SECURITY.md
|
|
92
65
|
- docs/AddressesApi.md
|
|
93
66
|
- docs/BatchSendShipments200Response.md
|
|
94
67
|
- docs/BatchSendShipments200ResponseResultsInner.md
|
|
@@ -268,7 +241,6 @@ files:
|
|
|
268
241
|
- docs/VerifyApiToken200Response.md
|
|
269
242
|
- docs/VerifyApiTokenRequest.md
|
|
270
243
|
- docs/WebhooksApi.md
|
|
271
|
-
- git_push.sh
|
|
272
244
|
- lib/zippendo.rb
|
|
273
245
|
- lib/zippendo/api/addresses_api.rb
|
|
274
246
|
- lib/zippendo/api/billing_api.rb
|
|
@@ -456,7 +428,7 @@ files:
|
|
|
456
428
|
- lib/zippendo/version.rb
|
|
457
429
|
- spec/spec_helper.rb
|
|
458
430
|
- zippendo.gemspec
|
|
459
|
-
homepage: https://www.zippendo.com
|
|
431
|
+
homepage: https://www.zippendo.com/docs/sdks/overview
|
|
460
432
|
licenses:
|
|
461
433
|
- MIT
|
|
462
434
|
metadata: {}
|
|
@@ -476,6 +448,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
476
448
|
requirements: []
|
|
477
449
|
rubygems_version: 3.6.9
|
|
478
450
|
specification_version: 4
|
|
479
|
-
summary: Zippendo
|
|
451
|
+
summary: 'Official Ruby SDK for the Zippendo shipping API: book shipments, print labels
|
|
452
|
+
and track parcels with PostNord, GLS, DAO, Bring, DHL, DPD, UPS and more.'
|
|
480
453
|
test_files:
|
|
481
454
|
- spec/spec_helper.rb
|
data/git_push.sh
DELETED
|
@@ -1,57 +0,0 @@
|
|
|
1
|
-
#!/bin/sh
|
|
2
|
-
# ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
|
|
3
|
-
#
|
|
4
|
-
# Usage example: /bin/sh ./git_push.sh wing328 openapi-petstore-perl "minor update" "gitlab.com"
|
|
5
|
-
|
|
6
|
-
git_user_id=$1
|
|
7
|
-
git_repo_id=$2
|
|
8
|
-
release_note=$3
|
|
9
|
-
git_host=$4
|
|
10
|
-
|
|
11
|
-
if [ "$git_host" = "" ]; then
|
|
12
|
-
git_host="github.com"
|
|
13
|
-
echo "[INFO] No command line input provided. Set \$git_host to $git_host"
|
|
14
|
-
fi
|
|
15
|
-
|
|
16
|
-
if [ "$git_user_id" = "" ]; then
|
|
17
|
-
git_user_id="zippendo"
|
|
18
|
-
echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
|
|
19
|
-
fi
|
|
20
|
-
|
|
21
|
-
if [ "$git_repo_id" = "" ]; then
|
|
22
|
-
git_repo_id="zippendo-ruby"
|
|
23
|
-
echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
|
|
24
|
-
fi
|
|
25
|
-
|
|
26
|
-
if [ "$release_note" = "" ]; then
|
|
27
|
-
release_note="Minor update"
|
|
28
|
-
echo "[INFO] No command line input provided. Set \$release_note to $release_note"
|
|
29
|
-
fi
|
|
30
|
-
|
|
31
|
-
# Initialize the local directory as a Git repository
|
|
32
|
-
git init
|
|
33
|
-
|
|
34
|
-
# Adds the files in the local repository and stages them for commit.
|
|
35
|
-
git add .
|
|
36
|
-
|
|
37
|
-
# Commits the tracked changes and prepares them to be pushed to a remote repository.
|
|
38
|
-
git commit -m "$release_note"
|
|
39
|
-
|
|
40
|
-
# Sets the new remote
|
|
41
|
-
git_remote=$(git remote)
|
|
42
|
-
if [ "$git_remote" = "" ]; then # git remote not defined
|
|
43
|
-
|
|
44
|
-
if [ "$GIT_TOKEN" = "" ]; then
|
|
45
|
-
echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
|
|
46
|
-
git remote add origin https://${git_host}/${git_user_id}/${git_repo_id}.git
|
|
47
|
-
else
|
|
48
|
-
git remote add origin https://${git_user_id}:"${GIT_TOKEN}"@${git_host}/${git_user_id}/${git_repo_id}.git
|
|
49
|
-
fi
|
|
50
|
-
|
|
51
|
-
fi
|
|
52
|
-
|
|
53
|
-
git pull origin master
|
|
54
|
-
|
|
55
|
-
# Pushes (Forces) the changes in the local repository up to the remote repository
|
|
56
|
-
echo "Git pushing to https://${git_host}/${git_user_id}/${git_repo_id}.git"
|
|
57
|
-
git push origin master 2>&1 | grep -v 'To https'
|