@zippendo/sdk 1.1.4 → 1.2.1

package/src/models/UpdateShipmentRequestCarrierSettings.ts

@@ -0,0 +1,101 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { CreateShippingRuleRequestAdditionalParametersValue } from './CreateShippingRuleRequestAdditionalParametersValue';
+import {
+    CreateShippingRuleRequestAdditionalParametersValueFromJSON,
+    CreateShippingRuleRequestAdditionalParametersValueFromJSONTyped,
+    CreateShippingRuleRequestAdditionalParametersValueToJSON,
+    CreateShippingRuleRequestAdditionalParametersValueToJSONTyped,
+} from './CreateShippingRuleRequestAdditionalParametersValue';
+
+/**
+ * 
+ * @export
+ * @interface UpdateShipmentRequestCarrierSettings
+ */
+export interface UpdateShipmentRequestCarrierSettings {
+    /**
+     * Identifier of the carrier to use.
+     * @type {string}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    carrierId: string;
+    /**
+     * Identifier of the carrier product/service.
+     * @type {string}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    productId: string;
+    /**
+     * Additional service codes requested from the carrier.
+     * @type {Array<string>}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    services: Array<string>;
+    /**
+     * Carrier-specific extra parameters as key/value pairs.
+     * @type {{ [key: string]: CreateShippingRuleRequestAdditionalParametersValue; }}
+     * @memberof UpdateShipmentRequestCarrierSettings
+     */
+    additionalParameters: { [key: string]: CreateShippingRuleRequestAdditionalParametersValue; };
+}
+
+/**
+ * Check if a given object implements the UpdateShipmentRequestCarrierSettings interface.
+ */
+export function instanceOfUpdateShipmentRequestCarrierSettings(value: object): value is UpdateShipmentRequestCarrierSettings {
+    if (!('carrierId' in value) || value['carrierId'] === undefined) return false;
+    if (!('productId' in value) || value['productId'] === undefined) return false;
+    if (!('services' in value) || value['services'] === undefined) return false;
+    if (!('additionalParameters' in value) || value['additionalParameters'] === undefined) return false;
+    return true;
+}
+
+export function UpdateShipmentRequestCarrierSettingsFromJSON(json: any): UpdateShipmentRequestCarrierSettings {
+    return UpdateShipmentRequestCarrierSettingsFromJSONTyped(json, false);
+}
+
+export function UpdateShipmentRequestCarrierSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestCarrierSettings {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'carrierId': json['carrierId'],
+        'productId': json['productId'],
+        'services': json['services'],
+        'additionalParameters': (mapValues(json['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValueFromJSON)),
+    };
+}
+
+export function UpdateShipmentRequestCarrierSettingsToJSON(json: any): UpdateShipmentRequestCarrierSettings {
+    return UpdateShipmentRequestCarrierSettingsToJSONTyped(json, false);
+}
+
+export function UpdateShipmentRequestCarrierSettingsToJSONTyped(value?: UpdateShipmentRequestCarrierSettings | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'carrierId': value['carrierId'],
+        'productId': value['productId'],
+        'services': value['services'],
+        'additionalParameters': (mapValues(value['additionalParameters'], CreateShippingRuleRequestAdditionalParametersValueToJSON)),
+    };
+}
+

package/src/models/UpdateShipmentRequestDroppoint.ts

@@ -0,0 +1,100 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Zippendo Public API
+ * Public API documentation for Zippendo. Authenticate using your API token (Bearer token prefixed with zipp_).  **Brands (sub-accounts).** An organization can be split into brands, each keeping its own orders, shipments and configuration separate. There are two ways to scope requests to one brand, and NEITHER changes any request body:  1. **Bind the token.** Create an API token with a `brandId` and every request it makes is confined    to that brand — reads filtered, writes stamped. This is the recommended way to give a single    brand\'s team its own credential. 2. **Send the `X-Zippendo-Brand` header.** An organization-wide token can scope an individual    request by sending the brand\'s id or slug in this header. Most SDKs let you set it once on the    client so every call inherits it.  A brand-bound token that receives an `X-Zippendo-Brand` header naming a different brand is rejected with `403 BRAND_ACCESS_DENIED` — the binding is never widened. Omit both and requests cover the whole organization, which is the behaviour of every existing token.  Records that belong to no brand carry `brandId: null`. Configuration (carriers, shipping rules, addresses) with a null brand is organization-wide and remains visible inside every brand; orders and shipments with a null brand are only visible organization-wide.  List endpoints additionally take a `?brandScope=own|shared|both` parameter to narrow further within whichever brand context already applies. `own` returns only rows assigned to that brand, and requires a brand context — a brand-bound token, a resolved brand session, or the `X-Zippendo-Brand` header above — otherwise `400`. `shared` returns only the organization-wide rows (equivalent to filtering `brandId=none`). The default, `both`, keeps the existing behaviour: a brand context sees its own rows plus the organization-wide ones. Set `X-Zippendo-Brand-Scope` as a client default to apply the same choice to every request instead of repeating the query parameter on each call — an explicit `brandScope` query parameter always wins over the header, and a blank header value is ignored.  Brands themselves are managed under the **Brands** tag. Retiring a brand is done with `POST /orgs/{orgId}/brands/{brandId}/archive` — permanent deletion is a dashboard-only action, since it is refused while any order, shipment, member or token still references the brand. Brands require a plan that includes them; creating one beyond your plan\'s limit returns `403`.
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@zippendo.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner } from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
+import {
+    ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON,
+    ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSONTyped,
+    ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON,
+    ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSONTyped,
+} from './ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner';
+
+/**
+ * Display details of the selected service point, stored alongside `servicePointId`. Used when applying a service-point shipping rule (whose parameters otherwise replace the stored droppoint).
+ * @export
+ * @interface UpdateShipmentRequestDroppoint
+ */
+export interface UpdateShipmentRequestDroppoint {
+    /**
+     * Identifier of the selected service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    id: string;
+    /**
+     * Display name of the service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    name: string;
+    /**
+     * Formatted address of the service point.
+     * @type {string}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    address: string;
+    /**
+     * Latitude/longitude of the service point.
+     * @type {Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>}
+     * @memberof UpdateShipmentRequestDroppoint
+     */
+    coordinates?: Array<ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInner>;
+}
+
+/**
+ * Check if a given object implements the UpdateShipmentRequestDroppoint interface.
+ */
+export function instanceOfUpdateShipmentRequestDroppoint(value: object): value is UpdateShipmentRequestDroppoint {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('address' in value) || value['address'] === undefined) return false;
+    return true;
+}
+
+export function UpdateShipmentRequestDroppointFromJSON(json: any): UpdateShipmentRequestDroppoint {
+    return UpdateShipmentRequestDroppointFromJSONTyped(json, false);
+}
+
+export function UpdateShipmentRequestDroppointFromJSONTyped(json: any, ignoreDiscriminator: boolean): UpdateShipmentRequestDroppoint {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'address': json['address'],
+        'coordinates': json['coordinates'] == null ? undefined : ((json['coordinates'] as Array<any>).map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerFromJSON)),
+    };
+}
+
+export function UpdateShipmentRequestDroppointToJSON(json: any): UpdateShipmentRequestDroppoint {
+    return UpdateShipmentRequestDroppointToJSONTyped(json, false);
+}
+
+export function UpdateShipmentRequestDroppointToJSONTyped(value?: UpdateShipmentRequestDroppoint | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'address': value['address'],
+        'coordinates': value['coordinates'] == null ? undefined : ((value['coordinates'] as Array<any>).map(ListShippingRules200ResponseDataInnerAdditionalParametersValueAnyOfCoordinatesInnerToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -37,6 +37,7 @@ export * from './CreateShipment201ResponseShippingRule';
 export * from './CreateShipment201ResponseTracking';
 export * from './CreateShipmentRequest';
 export * from './CreateShipmentRequestCarrierSettings';
+export * from './CreateShipmentRequestDroppoint';
 export * from './CreateShipmentRequestParcelsInner';
 export * from './CreateShipmentRequestParcelsInnerDimensions';
 export * from './CreateShipmentRequestParcelsInnerOrderLinesInner';
@@ -143,6 +144,8 @@ export * from './UpdateOrgBrandingRequest';
 export * from './UpdateOrgRequest';
 export * from './UpdateOrgWebhookRequest';
 export * from './UpdateShipmentRequest';
+export * from './UpdateShipmentRequestCarrierSettings';
+export * from './UpdateShipmentRequestDroppoint';
 export * from './UpdateShippingRuleRequest';
 export * from './VerifyApiToken200Response';
 export * from './VerifyApiTokenRequest';