@chrt-inc/typescript-sdk 0.0.174 → 0.0.183

package/dist/cjs/api/resources/orgProfiles/client/Client.js

@@ -105,32 +105,34 @@ class OrgProfiles {
         });
     }
     /**
-     * Get the avatar image URL for an organization using their handle. Returns the image URL from Clerk or a placeholder if not found.
+     * Create a new courier organization profile. This endpoint will fail if a profile already exists for the organization.
      *
-     * @param {Chrt.OrgProfilesGetAvatarRequest} request
+     * @param {Chrt.CourierOrgProfileClientCreate3} request
      * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgProfiles.getAvatar({
-     *         handle: "handle"
+     *     await client.orgProfiles.create({
+     *         schema_version: 1,
+     *         description: "description",
+     *         email_address_primary: "email_address_primary",
+     *         phone_number_primary: "phone_number_primary"
      *     })
      */
-    getAvatar(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getAvatar(request, requestOptions));
+    create(request, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
     }
-    __getAvatar(request, requestOptions) {
+    __create(request, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
-            const { handle } = request;
-            const _queryParams = {};
-            _queryParams["handle"] = handle;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "oort/org_profiles/avatar"),
-                method: "GET",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "oort/org_profiles/create"),
+                method: "POST",
                 headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                queryParameters: _queryParams,
+                contentType: "application/json",
+                requestType: "json",
+                body: request,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -158,7 +160,7 @@ class OrgProfiles {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/org_profiles/avatar.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/org_profiles/create.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -168,30 +170,25 @@ class OrgProfiles {
         });
     }
     /**
-     * Create a new courier organization profile. This endpoint will fail if a profile already exists for the organization.
+     * Update an existing courier organization profile. Can update one or more fields. Profile must exist before updating.
      *
-     * @param {Chrt.CourierOrgProfileClientCreate3} request
+     * @param {Chrt.CourierOrgProfileClientUpdate3} request
      * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgProfiles.create({
-     *         description: "description",
-     *         email_address_primary: "email_address_primary",
-     *         phone_number_primary: "phone_number_primary",
-     *         schema_version: 1
-     *     })
+     *     await client.orgProfiles.update()
      */
-    create(request, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__create(request, requestOptions));
+    update(request = {}, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
     }
-    __create(request, requestOptions) {
-        return __awaiter(this, void 0, void 0, function* () {
+    __update() {
+        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "oort/org_profiles/create"),
-                method: "POST",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "oort/org_profiles/update"),
+                method: "PATCH",
                 headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 contentType: "application/json",
                 requestType: "json",
@@ -223,7 +220,7 @@ class OrgProfiles {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling POST /oort/org_profiles/create.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /oort/org_profiles/update.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -233,29 +230,26 @@ class OrgProfiles {
         });
     }
     /**
-     * Update an existing courier organization profile. Can update one or more fields. Profile must exist before updating.
+     * Retrieve a courier organization profile using the organization's handle. This endpoint is used for public profile viewing.
      *
-     * @param {Chrt.CourierOrgProfileClientUpdate3} request
+     * @param {string} handle
      * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgProfiles.update()
+     *     await client.orgProfiles.getByHandle("handle")
      */
-    update(request = {}, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__update(request, requestOptions));
+    getByHandle(handle, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getByHandle(handle, requestOptions));
     }
-    __update() {
-        return __awaiter(this, arguments, void 0, function* (request = {}, requestOptions) {
+    __getByHandle(handle, requestOptions) {
+        return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, "oort/org_profiles/update"),
-                method: "PATCH",
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/org_profiles/${encodeURIComponent(handle)}`),
+                method: "GET",
                 headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
-                contentType: "application/json",
-                requestType: "json",
-                body: request,
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
                 maxRetries: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.maxRetries,
                 abortSignal: requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.abortSignal,
@@ -283,7 +277,7 @@ class OrgProfiles {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling PATCH /oort/org_profiles/update.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/org_profiles/{handle}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,
@@ -293,7 +287,7 @@ class OrgProfiles {
         });
     }
     /**
-     * Retrieve a courier organization profile using the organization's handle. This endpoint is used for public profile viewing.
+     * Returns the image URL from Clerk or a placeholder if not found.
      *
      * @param {string} handle
      * @param {OrgProfiles.RequestOptions} requestOptions - Request-specific configuration.
@@ -301,16 +295,16 @@ class OrgProfiles {
      * @throws {@link Chrt.UnprocessableEntityError}
      *
      * @example
-     *     await client.orgProfiles.getByHandle("handle")
+     *     await client.orgProfiles.getAvatar("handle")
      */
-    getByHandle(handle, requestOptions) {
-        return core.HttpResponsePromise.fromPromise(this.__getByHandle(handle, requestOptions));
+    getAvatar(handle, requestOptions) {
+        return core.HttpResponsePromise.fromPromise(this.__getAvatar(handle, requestOptions));
     }
-    __getByHandle(handle, requestOptions) {
+    __getAvatar(handle, requestOptions) {
         return __awaiter(this, void 0, void 0, function* () {
             var _a, _b, _c, _d;
             const _response = yield ((_a = this._options.fetcher) !== null && _a !== void 0 ? _a : core.fetcher)({
-                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/org_profiles/${encodeURIComponent(handle)}`),
+                url: core.url.join((_c = (_b = (yield core.Supplier.get(this._options.baseUrl))) !== null && _b !== void 0 ? _b : (yield core.Supplier.get(this._options.environment))) !== null && _c !== void 0 ? _c : environments.ChrtEnvironment.Local, `oort/org_profiles/avatar/${encodeURIComponent(handle)}`),
                 method: "GET",
                 headers: (0, headers_js_1.mergeHeaders)((_d = this._options) === null || _d === void 0 ? void 0 : _d.headers, (0, headers_js_1.mergeOnlyDefinedHeaders)({ Authorization: yield this._getAuthorizationHeader() }), requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.headers),
                 timeoutMs: (requestOptions === null || requestOptions === void 0 ? void 0 : requestOptions.timeoutInSeconds) != null ? requestOptions.timeoutInSeconds * 1000 : 60000,
@@ -340,7 +334,7 @@ class OrgProfiles {
                         rawResponse: _response.rawResponse,
                     });
                 case "timeout":
-                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/org_profiles/{handle}.");
+                    throw new errors.ChrtTimeoutError("Timeout exceeded when calling GET /oort/org_profiles/avatar/{handle}.");
                 case "unknown":
                     throw new errors.ChrtError({
                         message: _response.error.errorMessage,

package/dist/cjs/api/resources/orgProfiles/client/requests/CourierOrgProfileClientCreate3.d.ts

@@ -4,15 +4,15 @@
 /**
  * @example
  *     {
+ *         schema_version: 1,
  *         description: "description",
  *         email_address_primary: "email_address_primary",
- *         phone_number_primary: "phone_number_primary",
- *         schema_version: 1
+ *         phone_number_primary: "phone_number_primary"
  *     }
  */
 export interface CourierOrgProfileClientCreate3 {
+    schema_version: number;
     description: string;
     email_address_primary: string;
     phone_number_primary: string;
-    schema_version: number;
 }

package/dist/cjs/api/resources/orgProfiles/client/requests/index.d.ts

@@ -1,3 +1,2 @@
-export { type OrgProfilesGetAvatarRequest } from "./OrgProfilesGetAvatarRequest.js";
 export { type CourierOrgProfileClientCreate3 } from "./CourierOrgProfileClientCreate3.js";
 export { type CourierOrgProfileClientUpdate3 } from "./CourierOrgProfileClientUpdate3.js";

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

@@ -29,56 +29,73 @@ export declare class Orgs {
     protected readonly _options: Orgs.Options;
     constructor(_options?: Orgs.Options);
     /**
-     * Get the handle for the org from JWT
+     * Retrieves basic organization information from the authentication service.
      *
      * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.orgs.getHandle()
+     *     await client.orgs.getInfo()
      */
-    getHandle(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<string>;
-    private __getHandle;
+    getInfo(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<unknown>;
+    private __getInfo;
     /**
-     * Check if a handle is available, returns true if it is, false if it is not
+     * Lists all members of the authenticated organization with their roles and details.
      *
-     * @param {string} handle
      * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
      *
-     * @throws {@link Chrt.UnprocessableEntityError}
+     * @example
+     *     await client.orgs.listMembers()
+     */
+    listMembers(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgMemberDetails[]>;
+    private __listMembers;
+    /**
+     * Retrieves public organization data for the authenticated organization.
+     *
+     * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.orgs.getHandleAvailability("handle")
+     *     await client.orgs.getPublicData()
      */
-    getHandleAvailability(handle: string, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<boolean>;
-    private __getHandleAvailability;
+    getPublicData(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgPublicData2>;
+    private __getPublicData;
     /**
+     * Retrieves public organization data for a specific organization by ID.
+     *
+     * @param {string} orgId
      * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
      * @example
-     *     await client.orgs.getInfo()
+     *     await client.orgs.getPublicDataByOrgId("org_id")
      */
-    getInfo(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgMemberDetails[]>;
-    private __getInfo;
+    getPublicDataByOrgId(orgId: string, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgPublicData2>;
+    private __getPublicDataByOrgId;
     /**
+     * Retrieves the organization handle for the authenticated organization.
+     *
      * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
      *
      * @example
-     *     await client.orgs.listMembers()
+     *     await client.orgs.getHandle()
      */
-    listMembers(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgMemberDetails[]>;
-    private __listMembers;
+    getHandle(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<string>;
+    private __getHandle;
     /**
-     * Get the org public data for the org from JWT
+     * Checks if an organization handle is available for use.
      *
+     * @param {string} handle
      * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
      *
+     * @throws {@link Chrt.UnprocessableEntityError}
+     *
      * @example
-     *     await client.orgs.getPublicData()
+     *     await client.orgs.getHandleAvailability("handle")
      */
-    getPublicData(requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgPublicData2>;
-    private __getPublicData;
+    getHandleAvailability(handle: string, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<boolean>;
+    private __getHandleAvailability;
     /**
-     * Create org public data with handle and company name
+     * Creates public organization data with handle and company name for the authenticated organization.
      *
      * @param {Chrt.CreateOrgPublicDataReq} request
      * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
@@ -87,14 +104,14 @@ export declare class Orgs {
      *
      * @example
      *     await client.orgs.createPublicData({
-     *         company_name: "company_name",
-     *         handle: "handle"
+     *         handle: "handle",
+     *         company_name: "company_name"
      *     })
      */
     createPublicData(request: Chrt.CreateOrgPublicDataReq, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<boolean>;
     private __createPublicData;
     /**
-     * Update handle or company_name for an org
+     * Updates the organization handle or company name for the authenticated organization.
      *
      * @param {Chrt.UpdateOrgPublicDataReq} request
      * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
@@ -106,18 +123,5 @@ export declare class Orgs {
      */
     updatePublicData(request?: Chrt.UpdateOrgPublicDataReq, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<boolean>;
     private __updatePublicData;
-    /**
-     * Get the org public data for the org from org_id
-     *
-     * @param {string} orgId
-     * @param {Orgs.RequestOptions} requestOptions - Request-specific configuration.
-     *
-     * @throws {@link Chrt.UnprocessableEntityError}
-     *
-     * @example
-     *     await client.orgs.getPublicDataByOrgId("org_id")
-     */
-    getPublicDataByOrgId(orgId: string, requestOptions?: Orgs.RequestOptions): core.HttpResponsePromise<Chrt.OrgPublicData2>;
-    private __getPublicDataByOrgId;
     protected _getAuthorizationHeader(): Promise<string | undefined>;
 }