orb-apiamtic-sdk 0.0.1

data/lib/api_reference/apis/item_api.rb

@@ -0,0 +1,224 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # ItemApi
+  class ItemApi < BaseApi
+    # This endpoint returns a list of all Items, ordered in descending order by
+    # creation time.
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_items(limit: 20,
+                   cursor: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/items',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Items.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to create an [Item](/core-concepts#item).
+    # @param [NewItem] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_item(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/items',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Item.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint returns an item identified by its item_id.
+    # @param [String] item_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_item(item_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/items/{item_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(item_id, key: 'item_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Item.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint can be used to update properties on the Item.
+    # @param [String] item_id Required parameter: TODO: type description here
+    # @param [MapItemRequestParams] body Required parameter: TODO: type
+    # description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def update_item(item_id,
+                    body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/items/{item_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(item_id, key: 'item_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Item.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [String] item_id Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def archive_item(item_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/items/{item_id}/archive',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(item_id, key: 'item_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Item.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+  end
+end

data/lib/api_reference/apis/license_api.rb

@@ -0,0 +1,452 @@
+# api_reference
+#
+# This file was automatically generated by APIMATIC v3.0 (
+# https://www.apimatic.io ).
+
+module ApiReference
+  # LicenseApi
+  class LicenseApi < BaseApi
+    # This endpoint returns a list of all licenses for a subscription.
+    # @param [String] subscription_id Required parameter: TODO: type description
+    # here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [String] license_type_id Optional parameter: TODO: type description
+    # here
+    # @param [String] external_license_id Optional parameter: TODO: type
+    # description here
+    # @param [Status7] status Optional parameter: Example:
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def list_licenses(subscription_id,
+                      limit: 20,
+                      cursor: nil,
+                      license_type_id: nil,
+                      external_license_id: nil,
+                      status: nil)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(license_type_id, key: 'license_type_id'))
+                   .query_param(new_parameter(external_license_id, key: 'external_license_id'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseApiResources.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to create a new license for a user.
+    # If a start date is provided, the license will be activated at the
+    # **start** of the specified date in the customer's timezone.
+    # Otherwise, the activation time will default to the **start** of the
+    # current day in the customer's timezone.
+    # @param [NewLicense] body Required parameter: TODO: type description here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def create_license(body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/licenses',
+                                     Server::DEFAULT)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseApiResource.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to fetch a license given an external license
+    # identifier.
+    # @param [String] external_license_id Required parameter: TODO: type
+    # description here
+    # @param [String] subscription_id Required parameter: TODO: type description
+    # here
+    # @param [String] license_type_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_license_external_id(external_license_id,
+                                  subscription_id,
+                                  license_type_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/external_license_id/{external_license_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_license_id, key: 'external_license_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(license_type_id, key: 'license_type_id')
+                                 .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseApiResource.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # Returns usage and remaining credits for a license identified by its
+    # external license ID.
+    # Date range defaults to the current billing period if not specified.
+    # @param [String] external_license_id Required parameter: TODO: type
+    # description here
+    # @param [String] subscription_id Required parameter: TODO: type description
+    # here
+    # @param [String] license_type_id Required parameter: TODO: type description
+    # here
+    # @param [Date] start_date Optional parameter: TODO: type description here
+    # @param [Date] end_date Optional parameter: TODO: type description here
+    # @param [String] group_by Optional parameter: TODO: type description here
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_license_usage_by_external_id(external_license_id,
+                                         subscription_id,
+                                         license_type_id,
+                                         start_date: nil,
+                                         end_date: nil,
+                                         group_by: nil,
+                                         cursor: nil,
+                                         limit: 20)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/external_licenses/{external_license_id}/usage',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(external_license_id, key: 'external_license_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(license_type_id, key: 'license_type_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(start_date, key: 'start_date'))
+                   .query_param(new_parameter(end_date, key: 'end_date'))
+                   .query_param(new_parameter(group_by, key: 'group_by'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseUsages.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # Returns usage and remaining credits for all licenses of a given type on a
+    # subscription.
+    # Date range defaults to the current billing period if not specified.
+    # @param [String] subscription_id Required parameter: TODO: type description
+    # here
+    # @param [String] license_type_id Required parameter: TODO: type description
+    # here
+    # @param [Date] start_date Optional parameter: TODO: type description here
+    # @param [Date] end_date Optional parameter: TODO: type description here
+    # @param [String] group_by Optional parameter: TODO: type description here
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_license_usage_by_type(subscription_id,
+                                  license_type_id,
+                                  start_date: nil,
+                                  end_date: nil,
+                                  group_by: nil,
+                                  cursor: nil,
+                                  limit: 20)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/usage',
+                                     Server::DEFAULT)
+                   .query_param(new_parameter(subscription_id, key: 'subscription_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(license_type_id, key: 'license_type_id')
+                                 .is_required(true))
+                   .query_param(new_parameter(start_date, key: 'start_date'))
+                   .query_param(new_parameter(end_date, key: 'end_date'))
+                   .query_param(new_parameter(group_by, key: 'group_by'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseUsages.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to fetch a license given an identifier.
+    # @param [String] license_id Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def fetch_license(license_id)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/{license_id}',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(license_id, key: 'license_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseApiResource.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # This endpoint is used to deactivate an existing license.
+    # If an end date is provided, the license will be deactivated at the
+    # **start** of the specified date in the customer's timezone.
+    # Otherwise, the deactivation time will default to the **end** of the
+    # current day in the customer's timezone.
+    # @param [String] license_id Required parameter: TODO: type description
+    # here
+    # @param [DeactivateLicense] body Required parameter: TODO: type description
+    # here
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def deactivate_license(license_id,
+                           body)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/licenses/{license_id}/deactivate',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(license_id, key: 'license_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body)
+                                .is_required(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseApiResource.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+
+    # Returns usage and remaining credits for a specific license over a date
+    # range.
+    # Date range defaults to the current billing period if not specified.
+    # @param [String] license_id Required parameter: TODO: type description
+    # here
+    # @param [Date] start_date Optional parameter: TODO: type description here
+    # @param [Date] end_date Optional parameter: TODO: type description here
+    # @param [String] group_by Optional parameter: TODO: type description here
+    # @param [String] cursor Optional parameter: TODO: type description here
+    # @param [Integer] limit Optional parameter: Example:20
+    # @return [ApiResponse] Complete http response with raw body and status code.
+    def get_license_usage_by_id(license_id,
+                                start_date: nil,
+                                end_date: nil,
+                                group_by: nil,
+                                cursor: nil,
+                                limit: 20)
+      @api_call
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/licenses/{license_id}/usage',
+                                     Server::DEFAULT)
+                   .template_param(new_parameter(license_id, key: 'license_id')
+                                    .is_required(true)
+                                    .should_encode(true))
+                   .query_param(new_parameter(start_date, key: 'start_date'))
+                   .query_param(new_parameter(end_date, key: 'end_date'))
+                   .query_param(new_parameter(group_by, key: 'group_by'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('APIKeyAuth')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(LicenseUsages.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request',
+                                 APIException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 AuthorizationErrorException)
+                    .local_error('404',
+                                 'Not Found',
+                                 APIException)
+                    .local_error('409',
+                                 'Conflict',
+                                 IdempotencyRequestMismatchException)
+                    .local_error('413',
+                                 'Content Too Large',
+                                 APIException)
+                    .local_error('429',
+                                 'Too Many Requests',
+                                 TooManyRequestsException)
+                    .local_error('500',
+                                 'Internal Server Error',
+                                 ServerErrorException))
+        .execute
+    end
+  end
+end