@commercelayer/sdk
Version:
Commerce Layer Javascript SDK
1 lines • 13.6 kB
Source Map (JSON)
{"version":3,"sources":["../src/resources/organizations.ts"],"names":["ApiSingleton"],"mappings":";;;;;AAmSA,IAAM,aAAA,GAAN,MAAM,cAAA,SAAsBA,8BAAA,CAA2B;AAAA,EAEtD,OAAgB,IAAA,GAAyB,eAAA;AAAA,EAEzC,MAAM,YAAA,CAAa,cAAA,EAAuC,MAAA,EAAsC,OAAA,EAA8D;AAC7J,IAAA,MAAM,eAAA,GAAmB,eAAgC,EAAA,IAAM,cAAA;AAC/D,IAAA,OAAO,IAAA,CAAK,SAAA,CAAU,KAAA,CAAkB,EAAE,IAAA,EAAM,cAAA,EAAe,EAAG,CAAA,aAAA,EAAgB,eAAe,CAAA,aAAA,CAAA,EAAiB,MAAA,EAAQ,OAAO,CAAA;AAAA,EAClI;AAAA,EAGA,eAAe,QAAA,EAAyC;AACvD,IAAA,OAAO,QAAA,CAAS,IAAA,IAAS,QAAA,CAAS,IAAA,KAAS,cAAA,CAAc,IAAA;AAAA,EAC1D;AAAA,EAGA,aAAa,EAAA,EAAiD;AAC7D,IAAA,OAAO,KAAA,CAAM,qBAAsC,EAAE,CAAA;AAAA,EACtD;AAAA,EAEA,sBAAsB,GAAA,EAAkC;AACvD,IAAA,OAAO,KAAA,CAAM,qBAAA,CAAuC,GAAG,GAAG,CAAA;AAAA,EAC3D;AAAA,EAGA,IAAA,GAAyB;AACxB,IAAA,OAAO,cAAA,CAAc,IAAA;AAAA,EACtB;AAAA,EAEA,IAAA,GAAe;AACd,IAAA,OAAO,cAAA;AAAA,EACR;AAED,CAAA;AAGA,IAAM,QAAA,GAAW,IAAI,aAAA,EAAc;AACnC,IAAO,qBAAA,GAAQ","file":"chunk-YPGYBULL.cjs","sourcesContent":["import { ApiSingleton } from '../resource'\nimport type { Resource, ResourceId, ResourcesConfig, ResourceRel, ListResponse, ResourceSort, /* ResourceFilter */ } from '../resource'\nimport type { QueryParamsList } from '../query'\n\nimport type { EventStore } from './event_stores'\n\n\ntype OrganizationType = 'organizations'\ntype OrganizationRel = ResourceRel & { type: OrganizationType }\n\n\nexport type OrganizationSort = Pick<Organization, 'id'> & ResourceSort\n// export type OrganizationFilter = Pick<Organization, 'id'> & ResourceFilter\n\n\ninterface Organization extends Resource {\n\t\n\treadonly type: OrganizationType\n\n\t/** \n\t * The organization's internal name.\n\t * @example ```\"The Blue Brand\"```\n\t */\n\tname?: string | null\n\t/** \n\t * The organization's slug name.\n\t * @example ```\"the-blue-brand\"```\n\t */\n\tslug?: string | null\n\t/** \n\t * The organization's domain.\n\t * @example ```\"the-blue-brand.commercelayer.io\"```\n\t */\n\tdomain?: string | null\n\t/** \n\t * The organization's support phone.\n\t * @example ```\"+01 30800857\"```\n\t */\n\tsupport_phone?: string | null\n\t/** \n\t * The organization's support email.\n\t * @example ```\"support@bluebrand.com\"```\n\t */\n\tsupport_email?: string | null\n\t/** \n\t * The URL to the organization's logo.\n\t * @example ```\"https://bluebrand.com/img/logo.svg\"```\n\t */\n\tlogo_url?: string | null\n\t/** \n\t * The URL to the organization's favicon.\n\t * @example ```\"https://bluebrand.com/img/favicon.ico\"```\n\t */\n\tfavicon_url?: string | null\n\t/** \n\t * The organization's primary color.\n\t * @example ```\"#C8984E\"```\n\t */\n\tprimary_color?: string | null\n\t/** \n\t * The organization's Google Tag Manager ID.\n\t * @example ```\"GTM-5FJXX6\"```\n\t */\n\tgtm_id?: string | null\n\t/** \n\t * The organization's Google Tag Manager ID for test.\n\t * @example ```\"GTM-5FJXX7\"```\n\t */\n\tgtm_id_test?: string | null\n\t/** \n\t * The organization's configuration.\n\t * @example ```{\"mfe\":{\"default\":{\"links\":{\"cart\":\"https://cart.example.com/:order_id?accessToken=:access_token\",\"checkout\":\"https://checkout.example.com/:order_id?accessToken=:accessToken\",\"identity\":\"https://example.com/login\",\"microstore\":\"https://example.com/microstore/?accessToken=:access_token\",\"my_account\":\"https://example.com/my-custom-account?accessToken=:access_token\"},\"checkout\":{\"thankyou_page\":\"https://example.com/thanks/:lang/:orderId\",\"billing_countries\":[{\"value\":\"ES\",\"label\":\"Espana\"},{\"value\":\"IT\",\"label\":\"Italia\"},{\"value\":\"US\",\"label\":\"Unites States of America\"}],\"shipping_countries\":[{\"value\":\"ES\",\"label\":\"Espana\"},{\"value\":\"IT\",\"label\":\"Italia\"},{\"value\":\"US\",\"label\":\"Unites States of America\"}],\"billing_states\":{\"FR\":[{\"value\":\"PA\",\"label\":\"Paris\"},{\"value\":\"LY\",\"label\":\"Lyon\"},{\"value\":\"NI\",\"label\":\"Nice\"},{\"value\":\"MA\",\"label\":\"Marseille\"},{\"value\":\"BO\",\"label\":\"Bordeaux\"}]},\"shipping_states\":{\"FR\":[{\"value\":\"PA\",\"label\":\"Paris\"},{\"value\":\"LY\",\"label\":\"Lyon\"},{\"value\":\"NI\",\"label\":\"Nice\"},{\"value\":\"MA\",\"label\":\"Marseille\"},{\"value\":\"BO\",\"label\":\"Bordeaux\"}]},\"default_country\":\"US\"},\"urls\":{\"privacy\":\"https://example.com/privacy/:lang\",\"terms\":\"https://example.com/terms/:lang\"}},\"market:id:ZKcv13rT\":{\"links\":{\"cart\":\"https://example.com/custom-cart/:order_id?accessToken=:access_token\"},\"checkout\":{\"thankyou_page\":\"https://example.com/thanks/:order_id\"}}}}```\n\t */\n\tconfig?: Record<string, any> | null\n\t/** \n\t * Enables the redirect on the new Auth API.\n\t * @example ```true```\n\t */\n\tapi_auth_redirect?: boolean | null\n\t/** \n\t * Enables the rules engine for flex promotions and price list rules.\n\t */\n\tapi_rules_engine?: boolean | null\n\t/** \n\t * The fallback maximum number of conditions within a rules payload on a ruleable object, default is 150.\n\t * @example ```150```\n\t */\n\tapi_rules_engine_max_conditions_size?: number | null\n\t/** \n\t * The fallback maximum number of rules within a rules payload on a ruleable object, default is 15.\n\t * @example ```15```\n\t */\n\tapi_rules_engine_max_rules_size?: number | null\n\t/** \n\t * Forces the usage of the new Authentication API.\n\t * @example ```true```\n\t */\n\tapi_new_auth?: boolean | null\n\t/** \n\t * Enables the purge of cached single resources when list is purged.\n\t */\n\tapi_purge_single_resource?: boolean | null\n\t/** \n\t * The maximum length for the regular expressions, default is 5000.\n\t * @example ```5000```\n\t */\n\tapi_max_regex_length?: number | null\n\t/** \n\t * Indicates if AVS checking will be enforced during payment workflow by passing specific attributes, default is true.\n\t * @example ```true```\n\t */\n\taddresses_avs_check?: boolean | null\n\t/** \n\t * Indicates if the phone attribute is required for addresses, default is true.\n\t * @example ```true```\n\t */\n\taddresses_phone_required?: boolean | null\n\t/** \n\t * Indicates if a sales channel application without customer can read and update just guest orders.\n\t * @example ```true```\n\t */\n\torders_sales_channel_guest_only?: boolean | null\n\t/** \n\t * The minimum lapse in fraction of seconds to be observed between two consecutive shipments rebuilt. If shipments rebuilt is triggered within the minimum lapse, the update is performed, but no rebuilt is done.\n\t */\n\torders_min_rebuild_shipments_lapse?: number | null\n\t/** \n\t * The minimum lapse in fraction of seconds to be observed between two consecutive order refreshes. If refresh is triggered within the minimum lapse, the update is performed, but no order refresh is done.\n\t */\n\torders_min_refresh_lapse?: number | null\n\t/** \n\t * The maximum number line items allowed for a test order before disabling the autorefresh option.\n\t * @example ```50```\n\t */\n\torders_autorefresh_cutoff_test?: number | null\n\t/** \n\t * The maximum number line items allowed for a live order before disabling the autorefresh option.\n\t * @example ```500```\n\t */\n\torders_autorefresh_cutoff_live?: number | null\n\t/** \n\t * Enables orders number editing as a string in test (for enterprise plans only).\n\t */\n\torders_number_editable_test?: boolean | null\n\t/** \n\t * Enables orders number editing as a string in live (for enterprise plans only).\n\t */\n\torders_number_editable_live?: boolean | null\n\t/** \n\t * Enables to use the order number as payment reference on supported gateways.\n\t * @example ```true```\n\t */\n\torders_number_as_reference?: boolean | null\n\t/** \n\t * Enables raising of API errors in case the provided coupon code is invalid, default is true.\n\t * @example ```true```\n\t */\n\torders_invalid_coupon_errors?: boolean | null\n\t/** \n\t * Enables raising of API errors in case the provided gift card code is invalid, default is true.\n\t * @example ```true```\n\t */\n\torders_invalid_gift_card_errors?: boolean | null\n\t/** \n\t * Enables the validation of the generated stock line items and stock transfers before placing the order, default is false.\n\t */\n\torders_validate_shipping_stock?: boolean | null\n\t/** \n\t * The maximum number of SKUs allowed for bundles, default is 10.\n\t * @example ```10```\n\t */\n\tbundles_max_items_count?: number | null\n\t/** \n\t * The minimum length for coupon code, default is 8.\n\t * @example ```8```\n\t */\n\tcoupons_min_code_length?: number | null\n\t/** \n\t * The maximum length for coupon code, default is 40.\n\t * @example ```40```\n\t */\n\tcoupons_max_code_length?: number | null\n\t/** \n\t * Enables matching the gift card code by its exact value, instead of by its first charachters, default is false.\n\t */\n\tgift_cards_exact_code_matching?: boolean | null\n\t/** \n\t * The minimum length for gift card code, default is 8.\n\t * @example ```8```\n\t */\n\tgift_cards_min_code_length?: number | null\n\t/** \n\t * The maximum length for gift card code, default is 40.\n\t * @example ```40```\n\t */\n\tgift_cards_max_code_length?: number | null\n\t/** \n\t * The maximum number of concurrent cleanups allowed for your organization, default is 10.\n\t * @example ```10```\n\t */\n\tcleanups_max_concurrent_count?: number | null\n\t/** \n\t * The maximum number of concurrent exports allowed for your organization, default is 10.\n\t * @example ```10```\n\t */\n\texports_max_concurrent_count?: number | null\n\t/** \n\t * The maximum number of concurrent imports allowed for your organization, default is 10.\n\t * @example ```10```\n\t */\n\timports_max_concurrent_count?: number | null\n\t/** \n\t * Enables purging of cached resources upon succeeded imports.\n\t * @example ```true```\n\t */\n\timports_purge_cache?: boolean | null\n\t/** \n\t * Disables the interruption of the import in case its errors exceeds the 10% threshold, default is false.\n\t */\n\timports_skip_errors?: boolean | null\n\t/** \n\t * The maximum number for stock locations cutoff, default is 10.\n\t * @example ```10```\n\t */\n\tinventory_models_max_stock_locations_cutoff?: number | null\n\t/** \n\t * The maximum number of active concurrent promotions allowed for your organization, default is 10.\n\t * @example ```10```\n\t */\n\tpromotions_max_concurrent_count?: number | null\n\t/** \n\t * The maximum number of conditions within a rules payload on a promotion object, default is 150.\n\t * @example ```150```\n\t */\n\tpromotions_max_conditions_size?: number | null\n\t/** \n\t * The maximum number of rules within a rules payload on a promotion object, default is 15.\n\t * @example ```15```\n\t */\n\tpromotions_max_rules_size?: number | null\n\t/** \n\t * The maximum number of conditions within a rules payload on a price list object, default is 150.\n\t * @example ```150```\n\t */\n\tprice_lists_max_conditions_size?: number | null\n\t/** \n\t * The maximum number of rules within a rules payload on a price list object, default is 15.\n\t * @example ```15```\n\t */\n\tprice_lists_max_rules_size?: number | null\n\t/** \n\t * Enables triggering of webhooks during imports, default is false.\n\t */\n\timports_trigger_webhooks?: number | null\n\t/** \n\t * Enables the use of an external discount engine in place of the standard one, default is false.\n\t */\n\tdiscount_engines_enabled?: boolean | null\n\t/** \n\t * Enables raising of API errors in case of discount engine failure, default is false.\n\t */\n\tdiscount_engines_errors?: boolean | null\n\t/** \n\t * The maximum length for the tag name, default is 25.\n\t * @example ```25```\n\t */\n\ttags_max_name_length?: number | null\n\t/** \n\t * The maximum allowed number of tags for each resource, default is 10.\n\t * @example ```10```\n\t */\n\ttags_max_allowed_number?: number | null\n\t/** \n\t * Enables raising of API errors in case of tax calculation failure, default is false.\n\t */\n\ttax_calculators_errors?: boolean | null\n\t/** \n\t * Enables raising of API errors in case of external promotion failure, default is false.\n\t */\n\texternal_promotions_errors?: boolean | null\n\t/** \n\t * Enables raising of API errors in case of external price failure, default is true.\n\t * @example ```true```\n\t */\n\texternal_prices_errors?: boolean | null\n\n\tevent_stores?: EventStore[] | null\n\n}\n\n\nclass Organizations extends ApiSingleton<Organization> {\n\n\tstatic readonly TYPE: OrganizationType = 'organizations' as const\n\n\tasync event_stores(organizationId: string | Organization, params?: QueryParamsList<EventStore>, options?: ResourcesConfig): Promise<ListResponse<EventStore>> {\n\t\tconst _organizationId = (organizationId as Organization).id || organizationId as string\n\t\treturn this.resources.fetch<EventStore>({ type: 'event_stores' }, `organization/${_organizationId}/event_stores`, params, options) as unknown as ListResponse<EventStore>\n\t}\n\n\n\tisOrganization(resource: any): resource is Organization {\n\t\treturn resource.type && (resource.type === Organizations.TYPE)\n\t}\n\n\n\trelationship(id: string | ResourceId | null): OrganizationRel {\n\t\treturn super.relationshipOneToOne<OrganizationRel>(id)\n\t}\n\n\trelationshipToMany(...ids: string[]): OrganizationRel[] {\n\t\treturn super.relationshipOneToMany<OrganizationRel>(...ids)\n\t}\n\n\n\ttype(): OrganizationType {\n\t\treturn Organizations.TYPE\n\t}\n\n\tpath(): string {\n\t\treturn 'organization'\n\t}\n\n}\n\n\nconst instance = new Organizations()\nexport default instance\n\nexport type { Organizations, Organization, OrganizationType }\n"]}