zippendo 1.2.2 → 1.2.4
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/docs/AddressesApi.md +4 -0
- data/docs/CarriersApi.md +5 -1
- data/docs/ListAvailableCarriers200ResponseInner.md +5 -1
- data/docs/ListCarriers200ResponseDataInner.md +5 -1
- data/docs/RulesApi.md +5 -1
- data/docs/ShipmentsApi.md +7 -1
- data/docs/WebhooksApi.md +5 -1
- data/lib/zippendo/api/addresses_api.rb +14 -0
- data/lib/zippendo/api/carriers_api.rb +6 -0
- data/lib/zippendo/api/rules_api.rb +6 -0
- data/lib/zippendo/api/shipments_api.rb +17 -0
- data/lib/zippendo/api/webhooks_api.rb +6 -0
- data/lib/zippendo/models/list_available_carriers200_response_inner.rb +24 -4
- data/lib/zippendo/models/list_carriers200_response_data_inner.rb +24 -4
- data/lib/zippendo/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 54a0193feed7732ed8b6fa3deb76a66fec604b1cbc0eec7255f725d31fd8961a
|
|
4
|
+
data.tar.gz: a144d85c5cac5187193835d1bc8a783c77c6e4fc859d1122297a8c6fdd8ec2f9
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 9b8b5b3b91edf4ab152533523da8be766eb5d9e3f855fd20d19182e4a0ca7398449db5d0be47e7297f2fb2febf357ce1496703f5e6e61eb4b53b08d7715acf9b
|
|
7
|
+
data.tar.gz: 4243c74c12fd3747c86f1fbcaf2bc836914b13e4e038f730fbc746e1b598887ec3f76064de9420ca607c20e71d846bbb273847b1b60153eec2d6eca21615cc46
|
data/docs/AddressesApi.md
CHANGED
|
@@ -249,6 +249,8 @@ opts = {
|
|
|
249
249
|
page: 1, # Integer | Page number (1-based)
|
|
250
250
|
limit: 20, # Integer | Items per page (max 100)
|
|
251
251
|
type: 'sender', # String | Filter by address type (sender, pickup, return)
|
|
252
|
+
country_code: 'DK', # String | Filter by ISO 3166-1 alpha-2 country code.
|
|
253
|
+
search: 'Copenhagen', # String | Search by address name, contact or city.
|
|
252
254
|
brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
253
255
|
brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
254
256
|
}
|
|
@@ -288,6 +290,8 @@ end
|
|
|
288
290
|
| **page** | **Integer** | Page number (1-based) | [optional][default to 1] |
|
|
289
291
|
| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
|
|
290
292
|
| **type** | **String** | Filter by address type (sender, pickup, return) | [optional] |
|
|
293
|
+
| **country_code** | **String** | Filter by ISO 3166-1 alpha-2 country code. | [optional] |
|
|
294
|
+
| **search** | **String** | Search by address name, contact or city. | [optional] |
|
|
291
295
|
| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
|
|
292
296
|
| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
|
|
293
297
|
|
data/docs/CarriersApi.md
CHANGED
|
@@ -397,7 +397,9 @@ opts = {
|
|
|
397
397
|
page: 1, # Integer | Page number (1-based)
|
|
398
398
|
limit: 20, # Integer | Items per page (max 100)
|
|
399
399
|
brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
400
|
-
brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
400
|
+
brand_scope: 'own', # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
401
|
+
carrier_slug: 'gls', # String | Filter by carrier slug.
|
|
402
|
+
search: 'PostNord' # String | Search by carrier name.
|
|
401
403
|
}
|
|
402
404
|
|
|
403
405
|
begin
|
|
@@ -436,6 +438,8 @@ end
|
|
|
436
438
|
| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
|
|
437
439
|
| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
|
|
438
440
|
| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
|
|
441
|
+
| **carrier_slug** | **String** | Filter by carrier slug. | [optional] |
|
|
442
|
+
| **search** | **String** | Search by carrier name. | [optional] |
|
|
439
443
|
|
|
440
444
|
### Return type
|
|
441
445
|
|
|
@@ -15,6 +15,8 @@
|
|
|
15
15
|
| **optional_fields** | [**Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>**](ListAvailableCarriers200ResponseInnerRequiredFieldsInner.md) | Optional configuration fields for the carrier | [optional] |
|
|
16
16
|
| **deprecated** | **Boolean** | Whether this integration is deprecated (still works, but discouraged) | [optional] |
|
|
17
17
|
| **deprecation_message** | **String** | Guidance shown alongside the deprecated tag (e.g. what to migrate to) | [optional] |
|
|
18
|
+
| **generates_customs_documents** | **Boolean** | Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label. | [optional] |
|
|
19
|
+
| **generates_commercial_invoice** | **Boolean** | Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents. | [optional] |
|
|
18
20
|
|
|
19
21
|
## Example
|
|
20
22
|
|
|
@@ -32,7 +34,9 @@ instance = Zippendo::ListAvailableCarriers200ResponseInner.new(
|
|
|
32
34
|
required_fields: null,
|
|
33
35
|
optional_fields: null,
|
|
34
36
|
deprecated: true,
|
|
35
|
-
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration
|
|
37
|
+
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
|
|
38
|
+
generates_customs_documents: true,
|
|
39
|
+
generates_commercial_invoice: true
|
|
36
40
|
)
|
|
37
41
|
```
|
|
38
42
|
|
|
@@ -16,6 +16,8 @@
|
|
|
16
16
|
| **brand_color** | **String** | Carrier brand color (hex) | [optional] |
|
|
17
17
|
| **deprecated** | **Boolean** | Whether this carrier integration is deprecated (still works, but discouraged) | [optional] |
|
|
18
18
|
| **deprecation_message** | **String** | Guidance shown alongside the deprecated tag (e.g. what to migrate to) | [optional] |
|
|
19
|
+
| **generates_customs_documents** | **Boolean** | Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label. | [optional] |
|
|
20
|
+
| **generates_commercial_invoice** | **Boolean** | Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents. | [optional] |
|
|
19
21
|
|
|
20
22
|
## Example
|
|
21
23
|
|
|
@@ -34,7 +36,9 @@ instance = Zippendo::ListCarriers200ResponseDataInner.new(
|
|
|
34
36
|
logo: https://cdn.zippendo.com/logos/postnord.svg,
|
|
35
37
|
brand_color: #005BAA,
|
|
36
38
|
deprecated: true,
|
|
37
|
-
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration
|
|
39
|
+
deprecation_message: The standalone Instabox API is deprecated. Migrate to the Instabee-powered Instabox integration.,
|
|
40
|
+
generates_customs_documents: true,
|
|
41
|
+
generates_commercial_invoice: true
|
|
38
42
|
)
|
|
39
43
|
```
|
|
40
44
|
|
data/docs/RulesApi.md
CHANGED
|
@@ -249,7 +249,9 @@ opts = {
|
|
|
249
249
|
page: 1, # Integer | Page number (1-based)
|
|
250
250
|
limit: 20, # Integer | Items per page (max 100)
|
|
251
251
|
brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
252
|
-
brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
252
|
+
brand_scope: 'own', # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
253
|
+
carrier_id: 'carr_01HZX9K2QF', # String | Filter by carrier.
|
|
254
|
+
search: 'Home delivery' # String | Search by rule name.
|
|
253
255
|
}
|
|
254
256
|
|
|
255
257
|
begin
|
|
@@ -288,6 +290,8 @@ end
|
|
|
288
290
|
| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
|
|
289
291
|
| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
|
|
290
292
|
| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
|
|
293
|
+
| **carrier_id** | **String** | Filter by carrier. | [optional] |
|
|
294
|
+
| **search** | **String** | Search by rule name. | [optional] |
|
|
291
295
|
|
|
292
296
|
### Return type
|
|
293
297
|
|
data/docs/ShipmentsApi.md
CHANGED
|
@@ -550,7 +550,10 @@ opts = {
|
|
|
550
550
|
page: 1, # Integer | Page number (1-based)
|
|
551
551
|
limit: 20, # Integer | Items per page (max 100)
|
|
552
552
|
brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
553
|
-
brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
553
|
+
brand_scope: 'own', # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
554
|
+
status: 'draft', # String | Filter by shipment status.
|
|
555
|
+
type: 'outbound', # String | Filter by direction.
|
|
556
|
+
search: 'SHIP-1042' # String | Search by shipment reference or parcel tracking number.
|
|
554
557
|
}
|
|
555
558
|
|
|
556
559
|
begin
|
|
@@ -589,6 +592,9 @@ end
|
|
|
589
592
|
| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
|
|
590
593
|
| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
|
|
591
594
|
| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
|
|
595
|
+
| **status** | **String** | Filter by shipment status. | [optional] |
|
|
596
|
+
| **type** | **String** | Filter by direction. | [optional] |
|
|
597
|
+
| **search** | **String** | Search by shipment reference or parcel tracking number. | [optional] |
|
|
592
598
|
|
|
593
599
|
### Return type
|
|
594
600
|
|
data/docs/WebhooksApi.md
CHANGED
|
@@ -328,7 +328,9 @@ opts = {
|
|
|
328
328
|
page: 1, # Integer | Page number (1-based)
|
|
329
329
|
limit: 20, # Integer | Items per page (max 100)
|
|
330
330
|
brand_id: 'brnd_8f3kd92ld0', # String | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
331
|
-
brand_scope: 'own' # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
331
|
+
brand_scope: 'own', # String | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
332
|
+
is_active: 'true', # String | Filter by active state.
|
|
333
|
+
search: 'fulfilment' # String | Search by webhook name or URL.
|
|
332
334
|
}
|
|
333
335
|
|
|
334
336
|
begin
|
|
@@ -367,6 +369,8 @@ end
|
|
|
367
369
|
| **limit** | **Integer** | Items per page (max 100) | [optional][default to 20] |
|
|
368
370
|
| **brand_id** | **String** | Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand. | [optional] |
|
|
369
371
|
| **brand_scope** | **String** | How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context. | [optional] |
|
|
372
|
+
| **is_active** | **String** | Filter by active state. | [optional] |
|
|
373
|
+
| **search** | **String** | Search by webhook name or URL. | [optional] |
|
|
370
374
|
|
|
371
375
|
### Return type
|
|
372
376
|
|
|
@@ -238,6 +238,8 @@ module Zippendo
|
|
|
238
238
|
# @option opts [Integer] :page Page number (1-based) (default to 1)
|
|
239
239
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
240
240
|
# @option opts [String] :type Filter by address type (sender, pickup, return)
|
|
241
|
+
# @option opts [String] :country_code Filter by ISO 3166-1 alpha-2 country code.
|
|
242
|
+
# @option opts [String] :search Search by address name, contact or city.
|
|
241
243
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
242
244
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
243
245
|
# @return [ListAddresses200Response]
|
|
@@ -253,6 +255,8 @@ module Zippendo
|
|
|
253
255
|
# @option opts [Integer] :page Page number (1-based) (default to 1)
|
|
254
256
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
255
257
|
# @option opts [String] :type Filter by address type (sender, pickup, return)
|
|
258
|
+
# @option opts [String] :country_code Filter by ISO 3166-1 alpha-2 country code.
|
|
259
|
+
# @option opts [String] :search Search by address name, contact or city.
|
|
256
260
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
257
261
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
258
262
|
# @return [Array<(ListAddresses200Response, Integer, Hash)>] ListAddresses200Response data, response status code and response headers
|
|
@@ -284,6 +288,14 @@ module Zippendo
|
|
|
284
288
|
if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
|
|
285
289
|
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
286
290
|
end
|
|
291
|
+
if @api_client.config.client_side_validation && !opts[:'country_code'].nil? && opts[:'country_code'].to_s.length > 2
|
|
292
|
+
fail ArgumentError, 'invalid value for "opts[:"country_code"]" when calling AddressesApi.list_addresses, the character length must be smaller than or equal to 2.'
|
|
293
|
+
end
|
|
294
|
+
|
|
295
|
+
if @api_client.config.client_side_validation && !opts[:'country_code'].nil? && opts[:'country_code'].to_s.length < 2
|
|
296
|
+
fail ArgumentError, 'invalid value for "opts[:"country_code"]" when calling AddressesApi.list_addresses, the character length must be greater than or equal to 2.'
|
|
297
|
+
end
|
|
298
|
+
|
|
287
299
|
allowable_values = ["own", "shared", "both"]
|
|
288
300
|
if @api_client.config.client_side_validation && opts[:'brand_scope'] && !allowable_values.include?(opts[:'brand_scope'])
|
|
289
301
|
fail ArgumentError, "invalid value for \"brand_scope\", must be one of #{allowable_values}"
|
|
@@ -296,6 +308,8 @@ module Zippendo
|
|
|
296
308
|
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
297
309
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
298
310
|
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
311
|
+
query_params[:'countryCode'] = opts[:'country_code'] if !opts[:'country_code'].nil?
|
|
312
|
+
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
|
299
313
|
query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
|
|
300
314
|
query_params[:'brandScope'] = opts[:'brand_scope'] if !opts[:'brand_scope'].nil?
|
|
301
315
|
|
|
@@ -394,6 +394,8 @@ module Zippendo
|
|
|
394
394
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
395
395
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
396
396
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
397
|
+
# @option opts [String] :carrier_slug Filter by carrier slug.
|
|
398
|
+
# @option opts [String] :search Search by carrier name.
|
|
397
399
|
# @return [ListCarriers200Response]
|
|
398
400
|
def list_carriers(org_id, opts = {})
|
|
399
401
|
data, _status_code, _headers = list_carriers_with_http_info(org_id, opts)
|
|
@@ -408,6 +410,8 @@ module Zippendo
|
|
|
408
410
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
409
411
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
410
412
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
413
|
+
# @option opts [String] :carrier_slug Filter by carrier slug.
|
|
414
|
+
# @option opts [String] :search Search by carrier name.
|
|
411
415
|
# @return [Array<(ListCarriers200Response, Integer, Hash)>] ListCarriers200Response data, response status code and response headers
|
|
412
416
|
def list_carriers_with_http_info(org_id, opts = {})
|
|
413
417
|
if @api_client.config.debugging
|
|
@@ -446,6 +450,8 @@ module Zippendo
|
|
|
446
450
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
447
451
|
query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
|
|
448
452
|
query_params[:'brandScope'] = opts[:'brand_scope'] if !opts[:'brand_scope'].nil?
|
|
453
|
+
query_params[:'carrierSlug'] = opts[:'carrier_slug'] if !opts[:'carrier_slug'].nil?
|
|
454
|
+
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
|
449
455
|
|
|
450
456
|
# header parameters
|
|
451
457
|
header_params = opts[:header_params] || {}
|
|
@@ -239,6 +239,8 @@ module Zippendo
|
|
|
239
239
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
240
240
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
241
241
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
242
|
+
# @option opts [String] :carrier_id Filter by carrier.
|
|
243
|
+
# @option opts [String] :search Search by rule name.
|
|
242
244
|
# @return [ListShippingRules200Response]
|
|
243
245
|
def list_shipping_rules(org_id, opts = {})
|
|
244
246
|
data, _status_code, _headers = list_shipping_rules_with_http_info(org_id, opts)
|
|
@@ -253,6 +255,8 @@ module Zippendo
|
|
|
253
255
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
254
256
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
255
257
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
258
|
+
# @option opts [String] :carrier_id Filter by carrier.
|
|
259
|
+
# @option opts [String] :search Search by rule name.
|
|
256
260
|
# @return [Array<(ListShippingRules200Response, Integer, Hash)>] ListShippingRules200Response data, response status code and response headers
|
|
257
261
|
def list_shipping_rules_with_http_info(org_id, opts = {})
|
|
258
262
|
if @api_client.config.debugging
|
|
@@ -291,6 +295,8 @@ module Zippendo
|
|
|
291
295
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
292
296
|
query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
|
|
293
297
|
query_params[:'brandScope'] = opts[:'brand_scope'] if !opts[:'brand_scope'].nil?
|
|
298
|
+
query_params[:'carrierId'] = opts[:'carrier_id'] if !opts[:'carrier_id'].nil?
|
|
299
|
+
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
|
294
300
|
|
|
295
301
|
# header parameters
|
|
296
302
|
header_params = opts[:header_params] || {}
|
|
@@ -545,6 +545,9 @@ module Zippendo
|
|
|
545
545
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
546
546
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
547
547
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
548
|
+
# @option opts [String] :status Filter by shipment status.
|
|
549
|
+
# @option opts [String] :type Filter by direction.
|
|
550
|
+
# @option opts [String] :search Search by shipment reference or parcel tracking number.
|
|
548
551
|
# @return [ListShipments200Response]
|
|
549
552
|
def list_shipments(org_id, opts = {})
|
|
550
553
|
data, _status_code, _headers = list_shipments_with_http_info(org_id, opts)
|
|
@@ -559,6 +562,9 @@ module Zippendo
|
|
|
559
562
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
560
563
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
561
564
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
565
|
+
# @option opts [String] :status Filter by shipment status.
|
|
566
|
+
# @option opts [String] :type Filter by direction.
|
|
567
|
+
# @option opts [String] :search Search by shipment reference or parcel tracking number.
|
|
562
568
|
# @return [Array<(ListShipments200Response, Integer, Hash)>] ListShipments200Response data, response status code and response headers
|
|
563
569
|
def list_shipments_with_http_info(org_id, opts = {})
|
|
564
570
|
if @api_client.config.debugging
|
|
@@ -588,6 +594,14 @@ module Zippendo
|
|
|
588
594
|
if @api_client.config.client_side_validation && opts[:'brand_scope'] && !allowable_values.include?(opts[:'brand_scope'])
|
|
589
595
|
fail ArgumentError, "invalid value for \"brand_scope\", must be one of #{allowable_values}"
|
|
590
596
|
end
|
|
597
|
+
allowable_values = ["draft", "pending", "processing", "dispatched", "partly_dispatched", "error", "cancelled", "on_hold"]
|
|
598
|
+
if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
|
|
599
|
+
fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
|
|
600
|
+
end
|
|
601
|
+
allowable_values = ["outbound", "inbound"]
|
|
602
|
+
if @api_client.config.client_side_validation && opts[:'type'] && !allowable_values.include?(opts[:'type'])
|
|
603
|
+
fail ArgumentError, "invalid value for \"type\", must be one of #{allowable_values}"
|
|
604
|
+
end
|
|
591
605
|
# resource path
|
|
592
606
|
local_var_path = '/orgs/{orgId}/shipments'.sub('{orgId}', CGI.escape(org_id.to_s))
|
|
593
607
|
|
|
@@ -597,6 +611,9 @@ module Zippendo
|
|
|
597
611
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
598
612
|
query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
|
|
599
613
|
query_params[:'brandScope'] = opts[:'brand_scope'] if !opts[:'brand_scope'].nil?
|
|
614
|
+
query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
|
|
615
|
+
query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
|
|
616
|
+
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
|
600
617
|
|
|
601
618
|
# header parameters
|
|
602
619
|
header_params = opts[:header_params] || {}
|
|
@@ -330,6 +330,8 @@ module Zippendo
|
|
|
330
330
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
331
331
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
332
332
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
333
|
+
# @option opts [String] :is_active Filter by active state.
|
|
334
|
+
# @option opts [String] :search Search by webhook name or URL.
|
|
333
335
|
# @return [ListOrgWebhooks200Response]
|
|
334
336
|
def list_org_webhooks(org_id, opts = {})
|
|
335
337
|
data, _status_code, _headers = list_org_webhooks_with_http_info(org_id, opts)
|
|
@@ -344,6 +346,8 @@ module Zippendo
|
|
|
344
346
|
# @option opts [Integer] :limit Items per page (max 100) (default to 20)
|
|
345
347
|
# @option opts [String] :brand_id Filter by brand. Pass a brand ID, or \"none\" for records not assigned to any brand.
|
|
346
348
|
# @option opts [String] :brand_scope How the brand context narrows this list: \"own\" returns only rows assigned to the current brand (requires a brand session, a brand-bound token, or the X-Zippendo-Brand header), \"shared\" returns only unassigned organization-wide rows, \"both\" (default) returns both. The X-Zippendo-Brand-Scope header supplies a default when the parameter is omitted. For strictly brand-owned records (orders, shipments), a brand-scoped request combined with \"shared\" returns no rows, since those records are never visible organization-wide from within a brand context.
|
|
349
|
+
# @option opts [String] :is_active Filter by active state.
|
|
350
|
+
# @option opts [String] :search Search by webhook name or URL.
|
|
347
351
|
# @return [Array<(ListOrgWebhooks200Response, Integer, Hash)>] ListOrgWebhooks200Response data, response status code and response headers
|
|
348
352
|
def list_org_webhooks_with_http_info(org_id, opts = {})
|
|
349
353
|
if @api_client.config.debugging
|
|
@@ -382,6 +386,8 @@ module Zippendo
|
|
|
382
386
|
query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
|
|
383
387
|
query_params[:'brandId'] = opts[:'brand_id'] if !opts[:'brand_id'].nil?
|
|
384
388
|
query_params[:'brandScope'] = opts[:'brand_scope'] if !opts[:'brand_scope'].nil?
|
|
389
|
+
query_params[:'isActive'] = opts[:'is_active'] if !opts[:'is_active'].nil?
|
|
390
|
+
query_params[:'search'] = opts[:'search'] if !opts[:'search'].nil?
|
|
385
391
|
|
|
386
392
|
# header parameters
|
|
387
393
|
header_params = opts[:header_params] || {}
|
|
@@ -48,6 +48,12 @@ module Zippendo
|
|
|
48
48
|
# Guidance shown alongside the deprecated tag (e.g. what to migrate to)
|
|
49
49
|
attr_accessor :deprecation_message
|
|
50
50
|
|
|
51
|
+
# Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label.
|
|
52
|
+
attr_accessor :generates_customs_documents
|
|
53
|
+
|
|
54
|
+
# Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents.
|
|
55
|
+
attr_accessor :generates_commercial_invoice
|
|
56
|
+
|
|
51
57
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
52
58
|
def self.attribute_map
|
|
53
59
|
{
|
|
@@ -61,7 +67,9 @@ module Zippendo
|
|
|
61
67
|
:'required_fields' => :'requiredFields',
|
|
62
68
|
:'optional_fields' => :'optionalFields',
|
|
63
69
|
:'deprecated' => :'deprecated',
|
|
64
|
-
:'deprecation_message' => :'deprecationMessage'
|
|
70
|
+
:'deprecation_message' => :'deprecationMessage',
|
|
71
|
+
:'generates_customs_documents' => :'generatesCustomsDocuments',
|
|
72
|
+
:'generates_commercial_invoice' => :'generatesCommercialInvoice'
|
|
65
73
|
}
|
|
66
74
|
end
|
|
67
75
|
|
|
@@ -88,7 +96,9 @@ module Zippendo
|
|
|
88
96
|
:'required_fields' => :'Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>',
|
|
89
97
|
:'optional_fields' => :'Array<ListAvailableCarriers200ResponseInnerRequiredFieldsInner>',
|
|
90
98
|
:'deprecated' => :'Boolean',
|
|
91
|
-
:'deprecation_message' => :'String'
|
|
99
|
+
:'deprecation_message' => :'String',
|
|
100
|
+
:'generates_customs_documents' => :'Boolean',
|
|
101
|
+
:'generates_commercial_invoice' => :'Boolean'
|
|
92
102
|
}
|
|
93
103
|
end
|
|
94
104
|
|
|
@@ -165,6 +175,14 @@ module Zippendo
|
|
|
165
175
|
if attributes.key?(:'deprecation_message')
|
|
166
176
|
self.deprecation_message = attributes[:'deprecation_message']
|
|
167
177
|
end
|
|
178
|
+
|
|
179
|
+
if attributes.key?(:'generates_customs_documents')
|
|
180
|
+
self.generates_customs_documents = attributes[:'generates_customs_documents']
|
|
181
|
+
end
|
|
182
|
+
|
|
183
|
+
if attributes.key?(:'generates_commercial_invoice')
|
|
184
|
+
self.generates_commercial_invoice = attributes[:'generates_commercial_invoice']
|
|
185
|
+
end
|
|
168
186
|
end
|
|
169
187
|
|
|
170
188
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -227,7 +245,9 @@ module Zippendo
|
|
|
227
245
|
required_fields == o.required_fields &&
|
|
228
246
|
optional_fields == o.optional_fields &&
|
|
229
247
|
deprecated == o.deprecated &&
|
|
230
|
-
deprecation_message == o.deprecation_message
|
|
248
|
+
deprecation_message == o.deprecation_message &&
|
|
249
|
+
generates_customs_documents == o.generates_customs_documents &&
|
|
250
|
+
generates_commercial_invoice == o.generates_commercial_invoice
|
|
231
251
|
end
|
|
232
252
|
|
|
233
253
|
# @see the `==` method
|
|
@@ -239,7 +259,7 @@ module Zippendo
|
|
|
239
259
|
# Calculates hash code according to all attributes.
|
|
240
260
|
# @return [Integer] Hash code
|
|
241
261
|
def hash
|
|
242
|
-
[name, slug, group, description, logo, brand_color, learn_more_url, required_fields, optional_fields, deprecated, deprecation_message].hash
|
|
262
|
+
[name, slug, group, description, logo, brand_color, learn_more_url, required_fields, optional_fields, deprecated, deprecation_message, generates_customs_documents, generates_commercial_invoice].hash
|
|
243
263
|
end
|
|
244
264
|
|
|
245
265
|
# Builds the object from hash
|
|
@@ -51,6 +51,12 @@ module Zippendo
|
|
|
51
51
|
# Guidance shown alongside the deprecated tag (e.g. what to migrate to)
|
|
52
52
|
attr_accessor :deprecation_message
|
|
53
53
|
|
|
54
|
+
# Whether the carrier produces the customs declaration (CN22/CN23) itself and returns it with the label.
|
|
55
|
+
attr_accessor :generates_customs_documents
|
|
56
|
+
|
|
57
|
+
# Whether the carrier produces the commercial invoice itself and returns it with the label, e.g. via electronic trade documents.
|
|
58
|
+
attr_accessor :generates_commercial_invoice
|
|
59
|
+
|
|
54
60
|
# Attribute mapping from ruby-style variable name to JSON key.
|
|
55
61
|
def self.attribute_map
|
|
56
62
|
{
|
|
@@ -65,7 +71,9 @@ module Zippendo
|
|
|
65
71
|
:'logo' => :'logo',
|
|
66
72
|
:'brand_color' => :'brandColor',
|
|
67
73
|
:'deprecated' => :'deprecated',
|
|
68
|
-
:'deprecation_message' => :'deprecationMessage'
|
|
74
|
+
:'deprecation_message' => :'deprecationMessage',
|
|
75
|
+
:'generates_customs_documents' => :'generatesCustomsDocuments',
|
|
76
|
+
:'generates_commercial_invoice' => :'generatesCommercialInvoice'
|
|
69
77
|
}
|
|
70
78
|
end
|
|
71
79
|
|
|
@@ -93,7 +101,9 @@ module Zippendo
|
|
|
93
101
|
:'logo' => :'String',
|
|
94
102
|
:'brand_color' => :'String',
|
|
95
103
|
:'deprecated' => :'Boolean',
|
|
96
|
-
:'deprecation_message' => :'String'
|
|
104
|
+
:'deprecation_message' => :'String',
|
|
105
|
+
:'generates_customs_documents' => :'Boolean',
|
|
106
|
+
:'generates_commercial_invoice' => :'Boolean'
|
|
97
107
|
}
|
|
98
108
|
end
|
|
99
109
|
|
|
@@ -185,6 +195,14 @@ module Zippendo
|
|
|
185
195
|
if attributes.key?(:'deprecation_message')
|
|
186
196
|
self.deprecation_message = attributes[:'deprecation_message']
|
|
187
197
|
end
|
|
198
|
+
|
|
199
|
+
if attributes.key?(:'generates_customs_documents')
|
|
200
|
+
self.generates_customs_documents = attributes[:'generates_customs_documents']
|
|
201
|
+
end
|
|
202
|
+
|
|
203
|
+
if attributes.key?(:'generates_commercial_invoice')
|
|
204
|
+
self.generates_commercial_invoice = attributes[:'generates_commercial_invoice']
|
|
205
|
+
end
|
|
188
206
|
end
|
|
189
207
|
|
|
190
208
|
# Show invalid properties with the reasons. Usually used together with valid?
|
|
@@ -323,7 +341,9 @@ module Zippendo
|
|
|
323
341
|
logo == o.logo &&
|
|
324
342
|
brand_color == o.brand_color &&
|
|
325
343
|
deprecated == o.deprecated &&
|
|
326
|
-
deprecation_message == o.deprecation_message
|
|
344
|
+
deprecation_message == o.deprecation_message &&
|
|
345
|
+
generates_customs_documents == o.generates_customs_documents &&
|
|
346
|
+
generates_commercial_invoice == o.generates_commercial_invoice
|
|
327
347
|
end
|
|
328
348
|
|
|
329
349
|
# @see the `==` method
|
|
@@ -335,7 +355,7 @@ module Zippendo
|
|
|
335
355
|
# Calculates hash code according to all attributes.
|
|
336
356
|
# @return [Integer] Hash code
|
|
337
357
|
def hash
|
|
338
|
-
[id, name, carrier_slug, config, org_id, brand_id, created_at, updated_at, logo, brand_color, deprecated, deprecation_message].hash
|
|
358
|
+
[id, name, carrier_slug, config, org_id, brand_id, created_at, updated_at, logo, brand_color, deprecated, deprecation_message, generates_customs_documents, generates_commercial_invoice].hash
|
|
339
359
|
end
|
|
340
360
|
|
|
341
361
|
# Builds the object from hash
|
data/lib/zippendo/version.rb
CHANGED