@chrt-inc/typescript-sdk 0.0.170 → 0.1.0-beta1

package/dist/cjs/api/resources/oortShipperContactInfo/client/Client.d.ts

@@ -1,148 +0,0 @@
-/**
- * This file was auto-generated by Fern from our API Definition.
- */
-import * as environments from "../../../../environments.js";
-import * as core from "../../../../core/index.js";
-import * as Chrt from "../../../index.js";
-export declare namespace OortShipperContactInfo {
-    interface Options {
-        environment?: core.Supplier<environments.ChrtEnvironment | string>;
-        /** Specify a custom URL to connect the client to. */
-        baseUrl?: core.Supplier<string>;
-        token?: core.Supplier<core.BearerToken | undefined>;
-        /** Additional headers to include in requests. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
-        fetcher?: core.FetchFunction;
-    }
-    interface RequestOptions {
-        /** The maximum time to wait for a response in seconds. */
-        timeoutInSeconds?: number;
-        /** The number of times to retry the request. Defaults to 2. */
-        maxRetries?: number;
-        /** A hook to abort the request. */
-        abortSignal?: AbortSignal;
-        /** Additional headers to include in the request. */
-        headers?: Record<string, string | core.Supplier<string | undefined> | undefined>;
-    }
-}
-export declare class OortShipperContactInfo {
-    protected readonly _options: OortShipperContactInfo.Options;
-    constructor(_options?: OortShipperContactInfo.Options);
-    /**
-     * Get my own shipper contact info (for authenticated shippers users)
-     *
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.oortShipperContactInfo.getMyShipperContactInfo()
-     */
-    getMyShipperContactInfo(requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
-    private __getMyShipperContactInfo;
-    /**
-     * Get all contacts for my organization which were created by the shipper org (for authenticated shipper orgs)
-     *
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @example
-     *     await client.oortShipperContactInfo.getContactsForShipperOrg()
-     */
-    getContactsForShipperOrg(requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
-    private __getContactsForShipperOrg;
-    /**
-     * Get all contacts accessible to courier org for a specific on-platform shipper.
-     * Returns:
-     * 1. Contacts created by the courier org that are linked to the shipper org
-     * 2. Contacts created by the shipper org themselves (if courier and shipper are connected)
-     *
-     * @param {string} shipperOrgId
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.oortShipperContactInfo.getCourierContactsForOnPlatformShipper("shipper_org_id")
-     */
-    getCourierContactsForOnPlatformShipper(shipperOrgId: string, requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
-    private __getCourierContactsForOnPlatformShipper;
-    /**
-     * Get all contacts accessible to courier org for a specific off-platform shipper.
-     * Returns only contacts created by the courier org since off-platform shippers cannot create their own contacts.
-     *
-     * @param {string} offChrtShipperOrgConnectionInfoId
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.oortShipperContactInfo.getCourierContactsForOffPlatformShipper("off_chrt_shipper_org_connection_info_id")
-     */
-    getCourierContactsForOffPlatformShipper(offChrtShipperOrgConnectionInfoId: string, requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1[]>;
-    private __getCourierContactsForOffPlatformShipper;
-    /**
-     * Get a specific shipper contact info by ID
-     *
-     * @param {string} shipperContactInfoId
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.oortShipperContactInfo.getShipperContactInfoById("shipper_contact_info_id")
-     */
-    getShipperContactInfoById(shipperContactInfoId: string, requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<Chrt.ShipperContactInfo1>;
-    private __getShipperContactInfoById;
-    /**
-     * Create shipper contact info for on-platform shipper (scenarios 1 & 2)
-     *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.oortShipperContactInfo.createShipperContactInfoOnPlatform({
-     *         schema_version: 1
-     *     })
-     */
-    createShipperContactInfoOnPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
-    private __createShipperContactInfoOnPlatform;
-    /**
-     * Create shipper contact info for off-platform shipper (scenario 3)
-     *
-     * @param {Chrt.ShipperContactInfoClientCreate1} request
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.oortShipperContactInfo.createShipperContactInfoOffPlatform({
-     *         schema_version: 1
-     *     })
-     */
-    createShipperContactInfoOffPlatform(request: Chrt.ShipperContactInfoClientCreate1, requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<string>;
-    private __createShipperContactInfoOffPlatform;
-    /**
-     * @param {string} shipperContactInfoId
-     * @param {Chrt.ShipperContactInfoClientUpdate1} request
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.oortShipperContactInfo.updateShipperContactInfo("shipper_contact_info_id")
-     */
-    updateShipperContactInfo(shipperContactInfoId: string, request?: Chrt.ShipperContactInfoClientUpdate1, requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __updateShipperContactInfo;
-    /**
-     * @param {string} shipperContactInfoId
-     * @param {OortShipperContactInfo.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.oortShipperContactInfo.deleteShipperContactInfo("shipper_contact_info_id")
-     */
-    deleteShipperContactInfo(shipperContactInfoId: string, requestOptions?: OortShipperContactInfo.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __deleteShipperContactInfo;
-    protected _getAuthorizationHeader(): Promise<string | undefined>;
-}