From 39d019662d0e4d243bb3316ae5fb4a19a82f9582 Mon Sep 17 00:00:00 2001 From: Erin Date: Mon, 2 Mar 2026 14:09:26 -0800 Subject: [PATCH 1/3] =?UTF-8?q?=E2=8F=A9=20regen=20to=20API=201.0.436?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 1 + codegen/templates/Configuration.ts | 1 + codegen/templates/models/SdkConfiguration.ts | 1 + docs/classes/Resources.Configuration.html | 6 +++--- docs/classes/Resources.Me.html | 6 +++--- docs/classes/Resources.Subscriptions.html | 6 +++--- docs/interfaces/CookieOptions.html | 12 ++++++------ docs/interfaces/Resources.SortableMap.html | 4 ++-- docs/interfaces/SdkConfiguration.html | 15 ++++++++------- docs/variables/Configuration.html | 2 +- src/configuration.ts | 1 + src/models/SdkConfiguration.ts | 1 + src/models/Sortable.ts | 4 ++-- 13 files changed, 33 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 386b5da0..078c9c7b 100644 --- a/README.md +++ b/README.md @@ -206,6 +206,7 @@ Simply set the options you need to override and the SDK will merge it with the d import { Configuration } from 'ordercloud-javascript-sdk'; Configuration.Set({ + // This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal. baseApiUrl: 'https://sandboxapi.ordercloud.io', timeoutInMilliseconds: 20 * 1000 }) diff --git a/codegen/templates/Configuration.ts b/codegen/templates/Configuration.ts index ad2aa7dd..8407d407 100644 --- a/codegen/templates/Configuration.ts +++ b/codegen/templates/Configuration.ts @@ -2,6 +2,7 @@ import { SdkConfiguration } from './models' class Configuration { private defaultConfig: SdkConfiguration = { + // This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal. baseApiUrl: 'https://api.ordercloud.io', apiVersion: 'v1', timeoutInMilliseconds: 60 * 1000, // 60 seconds by default diff --git a/codegen/templates/models/SdkConfiguration.ts b/codegen/templates/models/SdkConfiguration.ts index ecf0c910..78b8c67a 100644 --- a/codegen/templates/models/SdkConfiguration.ts +++ b/codegen/templates/models/SdkConfiguration.ts @@ -4,6 +4,7 @@ export interface SdkConfiguration { /** * The apiurl that will be used to talk to the ordercloud API. * It may be useful to change this to interact with different environments + * This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal. * * Defaults to: https://api.ordercloud.io */ diff --git a/docs/classes/Resources.Configuration.html b/docs/classes/Resources.Configuration.html index 24fb6d33..a9cf1602 100644 --- a/docs/classes/Resources.Configuration.html +++ b/docs/classes/Resources.Configuration.html @@ -43,7 +43,7 @@

Properties

Private config

config: SdkConfiguration = ...
+
  • Defined in Configuration.ts:18

    • Private defaultConfig

    defaultConfig: SdkConfiguration = ...
    +
  • Defined in Configuration.ts:38

    • Set

    Returns void

    +
  • Defined in Configuration.ts:29
    • diff --git a/docs/classes/Resources.Me.html b/docs/classes/Resources.Me.html index 5935a8b5..f7928f66 100644 --- a/docs/classes/Resources.Me.html +++ b/docs/classes/Resources.Me.html @@ -2166,7 +2166,7 @@

    Returns Promise

    ListSubscriptions

      - +

    • List subscriptions visible to this user Check out the docs for more info

      @@ -2180,7 +2180,7 @@

      TSubscription extends Parameters

      • -
        listOptions: {
            filters?:         Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[];
            sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[];
        } = {}
        +
        listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[];
            sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!Interval" | "!NextOrderDate" | "!LastOrderDate" | "!EndDate")[];
        } = {}
        • Optional filters?: Filters
          @@ -2203,7 +2203,7 @@
          Optional searchOn

          Comma-delimited list of fields to search on.

    • -
      Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[]
      +
      Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!Interval" | "!NextOrderDate" | "!LastOrderDate" | "!EndDate")[]

      Comma-delimited list of fields to sort by.

  • diff --git a/docs/classes/Resources.Subscriptions.html b/docs/classes/Resources.Subscriptions.html index bb70800b..3bd99b8a 100644 --- a/docs/classes/Resources.Subscriptions.html +++ b/docs/classes/Resources.Subscriptions.html @@ -137,7 +137,7 @@

    Returns Promise

    List

      - +

    • List subscriptions Check out the docs for more info

      @@ -151,7 +151,7 @@

      TSubscription extends Parameters

      • -
        listOptions: {
            filters?:         Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[];
            sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[];
        } = {}
        +
        listOptions: {
            filters?: Filters;
            page?: number;
            pageSize?: number;
            search?: string;
            searchOn?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval")[];
            sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!Interval" | "!NextOrderDate" | "!LastOrderDate" | "!EndDate")[];
        } = {}
        • Optional filters?: Filters
          @@ -174,7 +174,7 @@
          Optional searchOn

          Comma-delimited list of fields to search on.

    • -
      Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[]
      +
      Optional sortBy?: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!Interval" | "!NextOrderDate" | "!LastOrderDate" | "!EndDate")[]

      Comma-delimited list of fields to sort by.

  • diff --git a/docs/interfaces/CookieOptions.html b/docs/interfaces/CookieOptions.html index 12db3b3e..c0f3adcf 100644 --- a/docs/interfaces/CookieOptions.html +++ b/docs/interfaces/CookieOptions.html @@ -20,7 +20,7 @@

    Hierarchy

    • CookieOptions
    +
  • Defined in models/SdkConfiguration.ts:43
    • @@ -42,7 +42,7 @@

    Optional

    The cookie will be available only for this domain and its sub-domains

    +
  • Defined in models/SdkConfiguration.ts:47

    • Optional path

    path?: string
    @@ -50,14 +50,14 @@

    Optional

    +
  • Defined in models/SdkConfiguration.ts:70

    • Optional prefix

    prefix?: string

    prefix for all cookies set by ordercloud

    +
  • Defined in models/SdkConfiguration.ts:64

    • Optional samesite

    samesite?: "none" | "strict" | "lax"
    @@ -65,7 +65,7 @@

    Optionalhttps://adzerk.com/blog/chrome-samesite/

    +
  • Defined in models/SdkConfiguration.ts:59

    • Optional secure

    secure?: boolean
    @@ -73,7 +73,7 @@

    Optional

    +
  • Defined in models/SdkConfiguration.ts:53
    • diff --git a/docs/interfaces/Resources.SortableMap.html b/docs/interfaces/Resources.SortableMap.html index 7ca6031c..cfd79664 100644 --- a/docs/interfaces/Resources.SortableMap.html +++ b/docs/interfaces/Resources.SortableMap.html @@ -369,7 +369,7 @@

    Me.ListSubscriptionItemsDefined in models/Sortable.ts:58

    Me.ListSubscriptions

    -
    Me.ListSubscriptions: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[]
    @@ -544,7 +544,7 @@

    SubscriptionItems.ListDefined in models/Sortable.ts:90

    Subscriptions.List

    -
    Subscriptions.List: ("ID" | "FromCompanyID" | "ToCompanyID" | "Interval" | "DateCreated" | "!ID" | "!DateCreated" | "FromUserID" | "!FromCompanyID" | "!ToCompanyID" | "!FromUserID" | "NextOrderDate" | "LastOrderDate" | "EndDate" | "!NextOrderDate" | "!LastOrderDate" | "!Interval" | "!EndDate")[]
    diff --git a/docs/interfaces/SdkConfiguration.html b/docs/interfaces/SdkConfiguration.html index d194393d..ce8b46d8 100644 --- a/docs/interfaces/SdkConfiguration.html +++ b/docs/interfaces/SdkConfiguration.html @@ -44,23 +44,24 @@

    OptionalDefaults to: v1

    +
  • Defined in models/SdkConfiguration.ts:18

    • Optional axiosAdapter

    axiosAdapter?: AxiosAdapter

    provide a custom axios adapter to handle dispatching request/responses

    +
  • Defined in models/SdkConfiguration.ts:38

    • Optional baseApiUrl

    baseApiUrl?: string

    The apiurl that will be used to talk to the ordercloud API. -It may be useful to change this to interact with different environments

    +It may be useful to change this to interact with different environments +This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal.

    Defaults to: https://api.ordercloud.io

    +
  • Defined in models/SdkConfiguration.ts:11

    • Optional clientID

    clientID?: string
    @@ -70,12 +71,12 @@

    Optional

    +
  • Defined in models/SdkConfiguration.ts:26

    • Optional cookieOptions

    cookieOptions?: CookieOptions
    +
  • Defined in models/SdkConfiguration.ts:40

    • Optional timeoutInMilliseconds

    timeoutInMilliseconds?: number
    @@ -84,7 +85,7 @@

    Optional

    +
  • Defined in models/SdkConfiguration.ts:33
    • diff --git a/docs/variables/Configuration.html b/docs/variables/Configuration.html index 4fce52ef..88eb310e 100644 --- a/docs/variables/Configuration.html +++ b/docs/variables/Configuration.html @@ -17,7 +17,7 @@

    Variable Configuration

    Configuration: Configuration
    +
  • Defined in Configuration.ts:49
    • diff --git a/src/configuration.ts b/src/configuration.ts index ad2aa7dd..8407d407 100644 --- a/src/configuration.ts +++ b/src/configuration.ts @@ -2,6 +2,7 @@ import { SdkConfiguration } from './models' class Configuration { private defaultConfig: SdkConfiguration = { + // This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal. baseApiUrl: 'https://api.ordercloud.io', apiVersion: 'v1', timeoutInMilliseconds: 60 * 1000, // 60 seconds by default diff --git a/src/models/SdkConfiguration.ts b/src/models/SdkConfiguration.ts index ecf0c910..78b8c67a 100644 --- a/src/models/SdkConfiguration.ts +++ b/src/models/SdkConfiguration.ts @@ -4,6 +4,7 @@ export interface SdkConfiguration { /** * The apiurl that will be used to talk to the ordercloud API. * It may be useful to change this to interact with different environments + * This URL can be found on your dashboard or in the upper right hand context menu of your OrderCloud application in Sitecore Portal. * * Defaults to: https://api.ordercloud.io */ diff --git a/src/models/Sortable.ts b/src/models/Sortable.ts index afb22854..a4628d6a 100644 --- a/src/models/Sortable.ts +++ b/src/models/Sortable.ts @@ -54,7 +54,7 @@ interface SortableMap { 'Me.ListShipments': ('DateShipped' | 'OwnerID' | 'ID' | 'BuyerID' | 'Shipper' | 'DateDelivered' | 'Cost' | '!DateShipped' | '!OwnerID' | '!ID' | '!BuyerID' | '!Shipper' | '!DateDelivered' | '!Cost')[] 'Me.ListShipmentItems': ('OrderID' | 'LineItemID' | '!OrderID' | '!LineItemID')[] 'Me.ListSpendingAccounts': ('Name' | 'ID' | '!Name' | '!ID')[] -'Me.ListSubscriptions': ('NextOrderDate' | 'LastOrderDate' | 'DateCreated' | 'ID' | 'Interval' | 'EndDate' | 'FromCompanyID' | 'FromUserID' | 'ToCompanyID' | '!NextOrderDate' | '!LastOrderDate' | '!DateCreated' | '!ID' | '!Interval' | '!EndDate' | '!FromCompanyID' | '!FromUserID' | '!ToCompanyID')[] +'Me.ListSubscriptions': ('ID' | 'Interval' | 'NextOrderDate' | 'LastOrderDate' | 'DateCreated' | 'EndDate' | 'FromCompanyID' | 'FromUserID' | 'ToCompanyID' | '!ID' | '!Interval' | '!NextOrderDate' | '!LastOrderDate' | '!DateCreated' | '!EndDate' | '!FromCompanyID' | '!FromUserID' | '!ToCompanyID')[] 'Me.ListSubscriptionItems': ('DateAdded' | 'ID' | 'ProductID' | '!DateAdded' | '!ID' | '!ProductID')[] 'Me.ListUserGroups': ('Name' | 'ID' | '!Name' | '!ID')[] 'MessageSenders.List': ('ID' | 'Name' | 'URL' | '!ID' | '!Name' | '!URL')[] @@ -86,7 +86,7 @@ interface SortableMap { 'Specs.List': ('ListOrder' | 'Name' | 'ID' | '!ListOrder' | '!Name' | '!ID')[] 'Specs.ListOptions': ('ListOrder' | 'ID' | '!ListOrder' | '!ID')[] 'Specs.ListProductAssignments': ('SpecID' | 'ProductID' | 'DefaultOptionID' | 'DefaultValue' | '!SpecID' | '!ProductID' | '!DefaultOptionID' | '!DefaultValue')[] -'Subscriptions.List': ('NextOrderDate' | 'LastOrderDate' | 'DateCreated' | 'ID' | 'Interval' | 'EndDate' | 'FromCompanyID' | 'FromUserID' | 'ToCompanyID' | '!NextOrderDate' | '!LastOrderDate' | '!DateCreated' | '!ID' | '!Interval' | '!EndDate' | '!FromCompanyID' | '!FromUserID' | '!ToCompanyID')[] +'Subscriptions.List': ('ID' | 'Interval' | 'NextOrderDate' | 'LastOrderDate' | 'DateCreated' | 'EndDate' | 'FromCompanyID' | 'FromUserID' | 'ToCompanyID' | '!ID' | '!Interval' | '!NextOrderDate' | '!LastOrderDate' | '!DateCreated' | '!EndDate' | '!FromCompanyID' | '!FromUserID' | '!ToCompanyID')[] 'SubscriptionItems.List': ('DateAdded' | 'ID' | 'ProductID' | '!DateAdded' | '!ID' | '!ProductID')[] 'Suppliers.List': ('ID' | 'Name' | 'DateCreated' | '!ID' | '!Name' | '!DateCreated')[] 'SupplierAddresses.List': ('AddressName' | 'ID' | 'DateCreated' | 'CompanyName' | 'FirstName' | 'LastName' | 'Street1' | 'Street2' | 'City' | 'State' | 'Zip' | 'Country' | 'Phone' | '!AddressName' | '!ID' | '!DateCreated' | '!CompanyName' | '!FirstName' | '!LastName' | '!Street1' | '!Street2' | '!City' | '!State' | '!Zip' | '!Country' | '!Phone')[] From af29700f6d062561cc6d2e7144a231e3dcae7300 Mon Sep 17 00:00:00 2001 From: Erin Date: Mon, 2 Mar 2026 14:10:25 -0800 Subject: [PATCH 2/3] =?UTF-8?q?=E2=9C=8F=EF=B8=8F=20update=20changelog?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CHANGELOG.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 62c08b0e..647ddae9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,9 @@ All notable changes to the ordercloud-javascript-sdk will be documented in this The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). +# [11.1.5] - 2026-03-02 +- Bring SDK up to date with API v1.0.436 + # [11.1.4] - 2025-12-17 - Bring SDK up to date with API v1.0.432 From be3449494fbb58e67dc3d7a06a4f26c795bed609 Mon Sep 17 00:00:00 2001 From: Erin Date: Mon, 2 Mar 2026 14:10:47 -0800 Subject: [PATCH 3/3] =?UTF-8?q?=F0=9F=94=96=2011.1.5?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index d166f57d..c8b13d65 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "ordercloud-javascript-sdk", "description": "The offical Javascript SDK for the Ordercloud ecommerce API", "author": "Four51 OrderCloud", - "version": "11.1.4", + "version": "11.1.5", "main": "dist/index.js", "umd:main": "dist/index.umd.js", "module": "dist/index.esm.js",