spree_api 4.5.5 → 4.6.0

data/docs/v2/platform/index.yaml

@@ -2200,6 +2200,282 @@ paths:
                     error: The access token is invalid
               schema:
                 "$ref": "#/components/schemas/error"
+  "/api/v2/platform/data_feeds":
+    get:
+      summary: Return a list of Data Feeds
+      tags:
+        - Data Feeds
+      security:
+        - bearer_auth: [ ]
+      operationId: data-feeds-list
+      parameters:
+        - name: page
+          in: query
+          example: 1
+          schema:
+            type: integer
+        - name: per_page
+          in: query
+          example: 50
+          schema:
+            type: integer
+      responses:
+        '200':
+          description: Records returned
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    data:
+                      - id: '1'
+                        type: data_feed
+                        attributes:
+                          name: First Data Feed
+                          type: Spree::DataFeed::Google
+                          slug: e593ae1f-630a-4f77-832f-0489da1c921b
+                          active: true
+                      - id: '2'
+                        type: data_feed
+                        attributes:
+                          name: Second Data Feed
+                          type: Spree::DataFeed::Google
+                          slug: 52f060f2-76cf-4983-89a3-714419941463
+                          active: true
+                    meta:
+                      count: 2
+                      total_count: 2
+                      total_pages: 1
+                    links:
+                      self: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+                      next: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+                      prev: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+                      last: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+                      first: http://www.example.com/api/v2/platform/data_feeds?page=1&per_page=
+              schema:
+                "$ref": "#/components/schemas/resources_list"
+        '401':
+          description: Authentication Failed
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: The access token is invalid
+              schema:
+                "$ref": "#/components/schemas/error"
+    post:
+      summary: Create a Data Feed
+      tags:
+        - Data Feeds
+      security:
+        - bearer_auth: [ ]
+      description: Creates a Data Feed
+      operationId: create-data-feed
+      parameters: [ ]
+      responses:
+        '201':
+          description: Record created
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    data:
+                      id: '1'
+                      type: data_feed
+                      attributes:
+                        name: First Data Feed
+                        type: Spree::DataFeed::Google
+                        slug: e593ae1f-630a-4f77-832f-0489da1c921b
+                        active: true
+              schema:
+                "$ref": "#/components/schemas/resource"
+        '422':
+          description: Invalid request
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: Data Feed name can't be blank
+                    errors:
+                      name:
+                        - can't be blank
+                      type:
+                        - can't be blank
+              schema:
+                "$ref": "#/components/schemas/validation_errors"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/create_data_feed_params"
+  "/api/v2/platform/data_feeds/{id}":
+    get:
+      summary: Return a Data Feed
+      tags:
+        - Data Feeds
+      security:
+        - bearer_auth: [ ]
+      description: Returns a Data Feed
+      operationId: show-data-feed
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Record found
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    data:
+                      id: '1'
+                      type: data_feed
+                      attributes:
+                        name: First Data Feed
+                        type: Spree::DataFeed::Google
+                        slug: e593ae1f-630a-4f77-832f-0489da1c921b
+                        active: true
+                      relationships:
+                        store:
+                          data:
+                            id: '1'
+                            type: store
+              schema:
+                "$ref": "#/components/schemas/resource"
+        '404':
+          description: Record not found
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: The resource you were looking for could not be found.
+              schema:
+                "$ref": "#/components/schemas/error"
+        '401':
+          description: Authentication Failed
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: The access token is invalid
+              schema:
+                "$ref": "#/components/schemas/error"
+    patch:
+      summary: Update a Data Feed
+      tags:
+        - Data Feeds
+      security:
+        - bearer_auth: [ ]
+      description: Updates a Data Feed
+      operationId: update-data-feed
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '200':
+          description: Record updated
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    data:
+                      id: '1'
+                      type: data_feed
+                      attributes:
+                        name: First Data Feed
+                        type: Spree::DataFeed::Google
+                        slug: e593ae1f-630a-4f77-832f-0489da1c921b
+                        active: true
+              schema:
+                "$ref": "#/components/schemas/resource"
+        '422':
+          description: Invalid request
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: Name is blank
+                    errors:
+                      name:
+                        - is blank
+              schema:
+                "$ref": "#/components/schemas/validation_errors"
+        '404':
+          description: Record not found
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: The resource you were looking for could not be found.
+              schema:
+                "$ref": "#/components/schemas/error"
+        '401':
+          description: Authentication Failed
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: The access token is invalid
+              schema:
+                "$ref": "#/components/schemas/error"
+      requestBody:
+        content:
+          application/json:
+            schema:
+              "$ref": "#/components/schemas/update_data_feed_params"
+    delete:
+      summary: Delete a Data Feed
+      tags:
+        - Data Feeds
+      security:
+        - bearer_auth: [ ]
+      description: Deletes a Data Feed
+      operationId: delete-data-feed
+      parameters:
+        - name: id
+          in: path
+          required: true
+          schema:
+            type: string
+      responses:
+        '204':
+          description: Record deleted
+        '404':
+          description: Record not found
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: The resource you were looking for could not be found.
+              schema:
+                "$ref": "#/components/schemas/error"
+        '401':
+          description: Authentication Failed
+          content:
+            application/vnd.api+json:
+              examples:
+                Example:
+                  value:
+                    error: The access token is invalid
+              schema:
+                "$ref": "#/components/schemas/error"
   "/api/v2/platform/digital_links":
     get:
       summary: Return a list of Digital Links
@@ -15490,6 +15766,7 @@ paths:
                         email: ivonne.braun@smith.biz
                         first_name: Liberty
                         last_name: Becker
+                        selected_locale: nil
                         created_at: '2022-11-08T19:35:53.726Z'
                         updated_at: '2022-11-08T19:35:53.726Z'
                         public_metadata: {}
@@ -15508,6 +15785,7 @@ paths:
                         email: lenita.mayer@kulas.us
                         first_name: Chasidy
                         last_name: Strosin
+                        selected_locale: 'fr'
                         created_at: '2022-11-08T19:35:53.730Z'
                         updated_at: '2022-11-08T19:35:53.730Z'
                         public_metadata: {}
@@ -15526,6 +15804,7 @@ paths:
                         email: dewayne@terrybarton.info
                         first_name: Ruben
                         last_name: Schmidt
+                        selected_locale: 'de'
                         created_at: '2022-11-08T19:35:53.732Z'
                         updated_at: '2022-11-08T19:35:53.732Z'
                         public_metadata: {}
@@ -15591,6 +15870,7 @@ paths:
                         email: rex_champlin@breitenberg.com
                         first_name: Zenia
                         last_name: King
+                        selected_locale: 'pl'
                         created_at: '2022-11-08T19:35:54.351Z'
                         updated_at: '2022-11-08T19:35:54.351Z'
                         public_metadata: {}
@@ -15660,6 +15940,7 @@ paths:
                         email: gaynell@parisian.biz
                         first_name: Irwin
                         last_name: DuBuque
+                        selected_locale: 'en'
                         created_at: '2022-11-08T19:35:54.635Z'
                         updated_at: '2022-11-08T19:35:54.635Z'
                         public_metadata: {}
@@ -15730,6 +16011,7 @@ paths:
                         email: john@example.com
                         first_name: Astrid
                         last_name: Kohler
+                        selected_locale: 'fr'
                         created_at: '2022-11-08T19:35:55.180Z'
                         updated_at: '2022-11-08T19:35:55.414Z'
                         public_metadata: {}
@@ -17669,7 +17951,7 @@ servers:
 - url: http://{defaultHost}
   variables:
     defaultHost:
-      default: localhost:3000
+      default: localhost:4000
 tags:
 - name: Addresses
 - name: Adjustments
@@ -19179,6 +19461,48 @@ components:
       - cms_section
       title: Update a Rich Text Section
       x-internal: false
+    create_data_feed_params:
+      type: object
+      properties:
+        data_feed:
+          type: object
+          required:
+          - name
+          - type
+          properties:
+            name:
+              type: string
+              example: 'First data feed'
+            slug:
+              type: string
+              example: 'first-data-feed'
+            type:
+              type: string
+              example: 'Spree::DataFeed::Google'
+            active:
+              type: boolean
+      x-internal: false
+    update_data_feed_params:
+      type: object
+      properties:
+        data_feed:
+          type: object
+          required:
+            - name
+            - type
+          properties:
+            name:
+              type: string
+              example: 'First data feed'
+            slug:
+              type: string
+              example: 'first-data-feed'
+            type:
+              type: string
+              example: 'Spree::DataFeed::Google'
+            active:
+              type: boolean
+      x-internal: false
     create_digital_params:
       type: object
       properties:
@@ -21338,6 +21662,8 @@ components:
               type: string
             password_confirmation:
               type: string
+            selected_locale:
+              type: string
             ship_address_id:
               type: string
             bill_address_id:
@@ -21365,6 +21691,8 @@ components:
               type: string
             password_confirmation:
               type: string
+            selected_locale:
+              type: string
             ship_address_id:
               type: string
             bill_address_id: