newstore-apimatic-sdk 0.0.1

data/lib/new_store_api/controllers/reservations_controller.rb

@@ -0,0 +1,266 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # ReservationsController
+  class ReservationsController < BaseController
+    # Gets the reservation configuration of the retailer.
+    # @return [ReservationConfigResponse] Response from the API call.
+    def show_reservation_config
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/inventory/config/reservations',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReservationConfigResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Updates the reservations configuration for the retailer.
+    # @param [ReservationConfigUpdate] body Required parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def update_reservation_config(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/inventory/config/reservations',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Lists all reservations, supporting various filters.
+    # @param [String] location_id Optional parameter: ID of the fulfillment
+    # location in which the reservations are being listed.
+    # @param [Array[ReservationStatusEnum]] status Optional parameter:
+    # Status(es) of the reservations to list. If omitted, all reservation
+    # statuses are listed.
+    # @param [String] external_id Optional parameter: If using V1 of the API,
+    # allows filtering on the user facing ID, and a partial match is also
+    # considered a match. If using V2, allows filtering on the external ID that
+    # was provided when the reservation was created, and only an exact match is
+    # considered a match.
+    # @param [String] display_id Optional parameter: Allows filtering the
+    # reservations by 'display_id'. A partial match is also considered a match.
+    # Only usable in V2 of the API.
+    # @param [String] customer_profile_id Optional parameter: Allows filtering
+    # the reservations by customer profile id
+    # @param [String] associate_id Optional parameter: Allows filtering the
+    # reservations by associate id
+    # @param [Integer] offset Optional parameter: Page number to return
+    # @param [Integer] count Optional parameter: Number of results to return in
+    # each page
+    # @param [Array[SortOptionsEnum]] sort Optional parameter: Field(s) to sort
+    # by. Supported values are 'created_at|asc' or 'status|asc' to list in
+    # ascending order and 'created_at|desc' or 'status|desc' to list in
+    # descending order.
+    # @param [TrueClass | FalseClass] expired Optional parameter: Filter for
+    # expired reservations
+    # @param [String] accept Optional parameter: Use this to specify the version
+    # of the API to use. Possible values are
+    # `application/vnd.com.newstore.reservations+json; version=2` and
+    # `application/vnd.com.newstore.reservations+json; version=1`
+    # @return [ListReservationsResponseV1] Response from the API call.
+    def list_reservations(location_id: nil,
+                          status: nil,
+                          external_id: nil,
+                          display_id: nil,
+                          customer_profile_id: nil,
+                          associate_id: nil,
+                          offset: 0,
+                          count: 10,
+                          sort: nil,
+                          expired: nil,
+                          accept: 'application/vnd.com.newstore.reservations+json; version=1')
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/inventory/reservations',
+                                     Server::API)
+                   .query_param(new_parameter(location_id, key: 'location_id'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(external_id, key: 'external_id'))
+                   .query_param(new_parameter(display_id, key: 'display_id'))
+                   .query_param(new_parameter(customer_profile_id, key: 'customer_profile_id'))
+                   .query_param(new_parameter(associate_id, key: 'associate_id'))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .query_param(new_parameter(sort, key: 'sort'))
+                   .query_param(new_parameter(expired, key: 'expired'))
+                   .header_param(new_parameter(accept, key: 'accept'))
+                   .auth(Single.new('oauth'))
+                   .array_serialization_format(ArraySerializationFormat::PLAIN))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListReservationsResponseV1.method(:from_hash)))
+        .execute
+    end
+
+    # Creates a new reservation. For each of the items in the reservation, 1
+    # unit of the corresponding product will be moved from the 'main' stock
+    # location to the '_customer_reservations' stock location at the specified
+    # fulfillment location.
+    # Reservations are created in the 'RESERVED' status by default, with an
+    # expiry date of 24 hours from when they have been created. The default
+    # duration of a reservation can by configured using the [Update Reservation
+    # Config](#/http/inventory/reservations/update-reservation-config) endpoint.
+    # **Important**: No stock is moved when a reservation expires. Stock is only
+    # moved back into the 'main' stock location when the reservation is
+    # converted to a sale or the item is unreserved. See [Update Reservation
+    # Items](#/http/inventory/reservations/update-reservation-items).
+    # If you specify the reservation status to be 'PENDING', no stock movements
+    # will occur, and the reservation will be shown as Pending in the Associate
+    # App. If a pending reservation is accepted, its status will change to
+    # 'RESERVED' and the stock will be moved. If a pending reservation is
+    # declined, its status will change to 'REJECTED' and no stock is moved.
+    # You can specify an external ID for a reservation (identifier of the
+    # reservation in an external system) by setting the Content-Type header of
+    # your request to `application/vnd.com.newstore.reservations+json;
+    # version=2` and including an `external_id` field in the body. If provided,
+    # `external_id` must be a string between 1 and 255 characters.
+    # @param [String] idempotency_key Required parameter: A unique value that
+    # should be the same between retries of the request. If a request has
+    # previously been received with the same idempotency key, the ID of the
+    # existing reservation will be returned instead of creating a new one. We
+    # recommend using a UUID for this value.
+    # @param [CreateReservationRequestV1] body Optional parameter: TODO: type
+    # description here
+    # @return [Object] Response from the API call.
+    def create_reservation(idempotency_key,
+                           body: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/inventory/reservations',
+                                     Server::API)
+                   .header_param(new_parameter(idempotency_key, key: 'Idempotency-Key'))
+                   .header_param(new_parameter('application/vnd.com.newstore.reservations+json; version=1', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize)))
+        .execute
+    end
+
+    # Retrieves a single reservation by ID.
+    # The reservation status is derived from the status of its items as follows:
+    # - Any item is RESERVED => Reservation is RESERVED
+    # - Some items are CONVERTED to a sale or UNRESERVED => Reservation is
+    # CONVERTED
+    # - All items are UNRESERVED => Reservation is UNRESERVED, meaning the
+    # reservation has been cancelled
+    # @param [UUID | String] reservation_id Required parameter: Reservation
+    # identifier.
+    # @param [String] accept Optional parameter: Use this to specify the version
+    # of the API to use. Possible values are
+    # `application/vnd.com.newstore.reservations+json; version=2` and
+    # `application/vnd.com.newstore.reservations+json; version=1`
+    # @return [ReservationDetailsResponseV1] Response from the API call.
+    def show_reservation(reservation_id,
+                         accept: 'application/vnd.com.newstore.reservations+json; version=1')
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/inventory/reservations/{reservation_id}',
+                                     Server::API)
+                   .template_param(new_parameter(reservation_id, key: 'reservation_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter(accept, key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ReservationDetailsResponseV1.method(:from_hash)))
+        .execute
+    end
+
+    # Updates the status of a 'PENDING' reservation to either 'REJECTED' or
+    # 'RESERVED'.
+    # If the status is changed to 'RESERVED', stock for each item in the
+    # reservation will be moved from the 'main' stock location to the
+    # '_customer_reservations' stock location and the expiry date will be reset.
+    # An email will be sent to the customer using the
+    # 'reservation_accepted_email' template if the 'send_accepted_email'
+    # [config](#/http/inventory/reservations/update-reservation-config) is
+    # enabled.
+    # If the status is changed to 'RESERVED', no stock will be moved, and an
+    # email will be sent to the customer using the 'reservation_rejected_email'
+    # template if the 'send_rejected_email'
+    # [config](#/http/inventory/reservations/update-reservation-config) is
+    # enabled.
+    # **Important**: This endpoint can only be used to update the status of
+    # reservations in the 'PENDING' status. All other status updates must be
+    # made at the item-level using the [Update Reservation
+    # Items](#/http/inventory/reservations/update-reservation-items) endpoint.
+    # @param [UUID | String] reservation_id Required parameter: Unique
+    # identifier of the reservation
+    # @param [ReservationUpdate] body Required parameter: TODO: type description
+    # here
+    # @return [void] Response from the API call.
+    def update_reservation(reservation_id,
+                           body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/inventory/reservations/{reservation_id}',
+                                     Server::API)
+                   .template_param(new_parameter(reservation_id, key: 'reservation_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Updates the status of a reservation's items.
+    # Items start in the 'RESERVED' status, and can only be updated to
+    # 'CONVERTED' or 'UNRESERVED'. 'CONVERTED' and 'UNRESERVED' are both
+    # terminal states; You cannot change or update the status of items with
+    # these statuses.
+    # Updating the status of a RESERVED item will cause 1 unit of the
+    # corresponding product to be moved from the '_customer_reservations' stock
+    # location to the 'main' stock location at the fulfillment location
+    # associated with the reservation.
+    # When setting an item's status to 'CONVERTED', you can provide an optional
+    # 'cart_id' which indicates  cart that the reserved products were added to.
+    # If this cart results in a purchase, a link to the corresponding order will
+    # be displayed alongside the item in the reservation details page in
+    # Omnichannel Manager. See [this
+    # guide](https://docs.newstore.com/v1/docs/monitoring-reservations).
+    # **Important**: This endpoint cannot be used to update the status of items
+    # currently in a 'PENDING' reservation. To do this, use the [Update
+    # Reservation](#/http/inventory/reservations/update-reservation) endpoint
+    # instead.
+    # @param [UUID | String] reservation_id Required parameter: Unique
+    # identifier of the reservation
+    # @param [Array[ReservationItemUpdate]] body Required parameter: TODO: type
+    # description here
+    # @return [void] Response from the API call.
+    def update_reservation_items(reservation_id,
+                                 body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PATCH,
+                                     '/inventory/reservations/{reservation_id}/items',
+                                     Server::API)
+                   .template_param(new_parameter(reservation_id, key: 'reservation_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+  end
+end

data/lib/new_store_api/controllers/roles_controller.rb

@@ -0,0 +1,149 @@
+# new_store_api
+#
+# This file was automatically generated for NewStore by
+# APIMATIC v3.0 ( https://www.apimatic.io ).
+
+module NewStoreApi
+  # RolesController
+  class RolesController < BaseController
+    # Lists all the user permissions available for the retailer.
+    # @return [GetPermissionsResponse] Response from the API call.
+    def list_permissions
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/permissions',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetPermissionsResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Lists all available user roles for the retailer. Search if the query
+    # parameter is used.
+    # @param [String] q Optional parameter: Query the resulting list by name.
+    # @return [GetRolesResponse] Response from the API call.
+    def list_roles(q: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/roles',
+                                     Server::API)
+                   .query_param(new_parameter(q, key: 'q'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetRolesResponse.method(:from_hash)))
+        .execute
+    end
+
+    # Creates a new role.
+    # @param [PostRolesRequest] body Required parameter: TODO: type description
+    # here
+    # @return [Role] Response from the API call.
+    def create_role(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/iam/roles',
+                                     Server::API)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Role.method(:from_hash)))
+        .execute
+    end
+
+    # Deletes the user role with the specified ID.
+    # Once deleted, the user role is unassigned from all associated user
+    # accounts.
+    # @param [String] id Required parameter: role id
+    # @return [void] Response from the API call.
+    def destroy_role(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/iam/roles/{id}',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .is_response_void(true))
+        .execute
+    end
+
+    # Retrieves the user role with the specified ID.
+    # @param [String] id Required parameter: role id
+    # @return [Role] Response from the API call.
+    def show_role(id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/roles/{id}',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Role.method(:from_hash)))
+        .execute
+    end
+
+    # Updates the user role with the specified ID.
+    # @param [String] id Required parameter: role id
+    # @param [PutRolesByIdRequest] body Required parameter: TODO: type
+    # description here
+    # @return [Role] Response from the API call.
+    def replace_role(id,
+                     body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/iam/roles/{id}',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Role.method(:from_hash)))
+        .execute
+    end
+
+    # Retrieves all user accounts that have been assigned the specified user
+    # role.
+    # @param [String] id Required parameter: role id
+    # @param [Integer] offset Optional parameter: The offset to be used for the
+    # resulting user account list.
+    # @param [Integer] count Optional parameter: The number of requested user
+    # accounts.
+    # @return [GetUsersByRoleResponse] Response from the API call.
+    def list_users_by_role(id,
+                           offset: 0,
+                           count: 25)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/iam/roles/{id}/users',
+                                     Server::API)
+                   .template_param(new_parameter(id, key: 'id')
+                                    .should_encode(true))
+                   .query_param(new_parameter(offset, key: 'offset'))
+                   .query_param(new_parameter(count, key: 'count'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oauth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetUsersByRoleResponse.method(:from_hash)))
+        .execute
+    end
+  end
+end