27 | *
28 | * > ### Note
29 | * > The Send a Test Request feature is not currently supported for this endpoint.
30 | *
31 | *
32 | *
33 | *
34 | */
35 | readonly getCurrentCustomer: {
36 | readonly parameters: {
37 | readonly query: {
38 | readonly app_client_id: string;
39 | };
40 | };
41 | readonly responses: {
42 | readonly default: {
43 | readonly schema: {
44 | readonly customer?: {
45 | /** Unique numeric ID of the customer. */
46 | readonly id?: number;
47 | /** Email address of the customer. */
48 | readonly email?: string;
49 | /** The group to which the customer belongs. */
50 | readonly group_id?: string;
51 | };
52 | /** Indicates the token’s issuer. This is your application’s client ID, which is obtained during application registration in Developer Portal. */
53 | readonly iss?: string;
54 | /** The subject of the JWT - same as `store_hash`. */
55 | readonly sub?: string;
56 | /** Time when the token was generated. This is a numeric value indicating the number of seconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). */
57 | readonly iat?: number;
58 | /** Time when the token expires. The token usually expires after 15 minutes. This is a numeric value indicating the number of seconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). */
59 | readonly exp?: number;
60 | /** Version of the Current Customer JWT */
61 | readonly version?: number;
62 | /** The "aud" (audience) claim identifies the recipients that the JWT is intended for. This should match the *App Client ID* and the `application_id`. */
63 | readonly aud?: string;
64 | /** The client ID created when the token was generated. */
65 | readonly application_id?: string;
66 | /** Store hash identifying the store you are logging into. */
67 | readonly store_hash?: string;
68 | /** Must contain the string “current_customer”. */
69 | readonly operation?: string;
70 | };
71 | };
72 | };
73 | };
74 | }
75 |
--------------------------------------------------------------------------------
/lib/internal/reference/generated/current_customer.js:
--------------------------------------------------------------------------------
1 | "use strict";
2 | /**
3 | * This file was auto-generated by openapi-typescript.
4 | * Do not make direct changes to the file.
5 | */
6 | Object.defineProperty(exports, "__esModule", { value: true });
7 |
--------------------------------------------------------------------------------
/lib/internal/reference/generated/custom_template_associations.v3.js:
--------------------------------------------------------------------------------
1 | "use strict";
2 | /**
3 | * This file was auto-generated by openapi-typescript.
4 | * Do not make direct changes to the file.
5 | */
6 | Object.defineProperty(exports, "__esModule", { value: true });
7 |
--------------------------------------------------------------------------------
/lib/internal/reference/generated/customer_login.d.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * This file was auto-generated by openapi-typescript.
3 | * Do not make direct changes to the file.
4 | */
5 | export interface paths {
6 | readonly "/login/token/{jwt_token}": {
7 | /**
8 | * The customer login access point URL.
9 | *
10 | * [Learn more about the Customer Login API](https://developer.bigcommerce.com/api-docs/customers/customer-login-api).
11 | *
12 | * ## Example
13 | *
14 | * ```
15 | * https://storedomain.com/login/token/eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJ7Y2xpZW50X2lkfSIsImlhdCI6MTUzNTM5MzExMywianRpIjoie3V1aWR9Iiwib3BlcmF0aW9uIjoiY3VzdG9tZXJfbG9naW4iLCJzdG9yZV9oYXNoIjoie3N0b3JlX2hhc2h9IiwiY3VzdG9tZXJfaWQiOjJ9.J-fAtbjRFGdLsT744DhoprFEDqIfVq72HbDzrbFy6Is
16 | * ```
17 | */
18 | readonly get: {
19 | readonly parameters: {
20 | readonly path: {
21 | readonly jwt_token: string;
22 | };
23 | };
24 | readonly responses: {};
25 | };
26 | readonly parameters: {
27 | readonly path: {
28 | readonly jwt_token: string;
29 | };
30 | };
31 | };
32 | }
33 | export interface definitions {
34 | readonly customerLoginSSO: {
35 | /** Indicates the token’s issuer. This is your application’s client ID, which is obtained during application registration in Developer Portal. */
36 | readonly iss?: string;
37 | /** Time when the token was generated. This is a numeric value indicating the number of seconds since the [Unix epoch](https://en.wikipedia.org/wiki/Unix_time). */
38 | readonly iat?: number;
39 | /** Request ID string that must be unique across all requests made by your app. A UUID or other random string would be an appropriate value. Most libraries contain a method for generating a uuid. For testing a [UUID generator](https://www.uuidgenerator.net/) can be used, but it recommended to use built in libraries. */
40 | readonly jti?: string;
41 | /** Must contain the string “customer_login”. */
42 | readonly operation?: string;
43 | /** Store hash identifying the store you are logging into. */
44 | readonly store_hash?: string;
45 | /** ID of the customer you are logging in, as obtained through the Customer API. */
46 | readonly customer_id?: number;
47 | /** Optional field containing a relative path for the shopper’s destination after login. Will default to `/account.php`. */
48 | readonly redirect_to?: string;
49 | /** **(Optional)** Field containing the expected IP address for the request. If provided, BigCommerce will check that it matches the browser trying to log in. If there is not a match, it will be rejected. */
50 | readonly request_ip?: string;
51 | };
52 | }
53 | export interface operations {
54 | }
55 |
--------------------------------------------------------------------------------
/lib/internal/reference/generated/customer_login.js:
--------------------------------------------------------------------------------
1 | "use strict";
2 | /**
3 | * This file was auto-generated by openapi-typescript.
4 | * Do not make direct changes to the file.
5 | */
6 | Object.defineProperty(exports, "__esModule", { value: true });
7 |
--------------------------------------------------------------------------------
/lib/internal/reference/generated/customers.sf.d.ts:
--------------------------------------------------------------------------------
1 | /**
2 | * This file was auto-generated by openapi-typescript.
3 | * Do not make direct changes to the file.
4 | */
5 | export interface paths {
6 | readonly "/customers": {
7 | /**
8 | * Creates a *Customer*.
9 | *
10 | *
11 | *
12 | *
13 | *
14 | * > ### Note
15 | * > The Send a Test Request feature is not currently supported for this endpoint.
16 | *
17 | *