mollie-api-ruby 3.1.5 → 4.0.0.pre.alpha.1

data/examples/apis/api_docs.rb

@@ -1,37 +0,0 @@
-class Application < Sinatra::Application
-  ::Application
-  swagger_root do
-    key :swagger, '2.0'
-    info version:        Mollie::VERSION,
-         title:          'Mollie',
-         description:    'Examples for the mollie api',
-         termsOfService: 'https://github.com/mollie/mollie-api-ruby',
-         contact:        { name: 'Mollie B.V.' },
-         license:        { name: 'BSD' }
-    key :basePath, '/'
-    key :consumes, %w(application/json multipart/form-data)
-    key :produces, ['application/json', "text/plain"]
-
-    security_definition :api_key do
-      key :type, :apiKey
-      key :name, :"X-Mollie-Api-Key"
-      key :in, :header
-    end
-  end
-
-  swagger_schema :ErrorModel do
-    property :message do
-      key :type, :string
-    end
-  end
-
-  get '/' do
-    # redirect "http://petstore.swagger.io/?url=#{Ngrok::Tunnel.ngrok_url_https}/api-docs"
-    redirect "#{Ngrok::Tunnel.ngrok_url_https}/index.html"
-  end
-
-  get '/api-docs' do
-    content_type :json
-    Swagger::Blocks.build_root_json([Application ]).to_json
-  end
-end

data/examples/apis/chargebacks.rb

@@ -1,17 +0,0 @@
-class Application < Sinatra::Application
-  swagger_path '/v1/chargebacks' do
-    operation :get, description: 'List chargebacks https://www.mollie.com/en/docs/reference/chargebacks/list', tags: ['Chargebacks'] do
-      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
-      parameter name: :count, in: 'query', description: 'Count', type: :integer
-      parameter name: :testmode, in: 'query', description: 'Test mode', type: :boolean
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  get '/v1/chargebacks' do
-    chargebacks = Mollie::Chargeback.all(params[:offset], params[:limit], testmode: params[:test_mode])
-    JSON.pretty_generate(chargebacks.attributes)
-  end
-end

data/examples/apis/connect.rb

@@ -1,58 +0,0 @@
-require 'rack/oauth2'
-class Application < Sinatra::Application
-  swagger_path '/oauth2/authorize' do
-    operation :get, description: 'https://www.mollie.com/en/docs/reference/oauth/authorize', tags: ['Connect'] do
-      parameter name: :client_id, in: 'query', description: 'Client Id', type: :string
-      parameter name: :secret, in: 'query', description: 'oAuth Secret', type: :string
-      parameter name: :redirect_uri, in: 'query', description: 'Redirect URI', type: :string, default: "#{Ngrok::Tunnel.ngrok_url_https}/token"
-      parameter name: :state, in: 'query', description: 'State', type: :string, default: SecureRandom.uuid
-      parameter name: :scope, in: 'query', description: 'Scope', type: :string, default: Mollie::Permission::AVAILABLE.join(' ')
-      parameter name: :response_type, in: 'query', description: 'Response Type', type: :string
-      parameter name: :approval_prompt, in: 'query', description: 'Approval prompt', type: :boolean
-      security api_key: []
-      response 301, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/oauth2/token' do
-    operation :get, description: 'Get access token', tags: ['Connect'] do
-      parameter name: :client_id, in: 'query', description: 'Client Id', type: :string
-      parameter name: :secret, in: 'query', description: 'oAuth Secret', type: :string
-      parameter name: :redirect_uri, in: 'query', description: 'Redirect URI', type: :string, default: "#{Ngrok::Tunnel.ngrok_url_https}/token"
-      parameter name: :code, in: 'query', description: 'Authorization code', type: :string
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  get '/oauth2/authorize' do
-    client = Rack::OAuth2::Client.new(
-        identifier:             params[:client_id],
-        secret:                 params[:secret],
-        state:                  params[:state],
-        redirect_uri:           params[:redirect_uri],
-        authorization_endpoint: 'https://www.mollie.com/oauth2/authorize',
-        token_endpoint:         'https://api.mollie.nl/oauth2/tokens'
-    )
-    client.authorization_uri(state: params[:state], scope: params[:scope], approval_prompt: params[:approval_prompt])
-  end
-
-  get '/token' do
-    params[:code]
-  end
-
-  get '/oauth2/token' do
-    client = Rack::OAuth2::Client.new(
-        identifier:             params[:client_id],
-        secret:                 params[:secret],
-        redirect_uri:           params[:redirect_uri],
-        authorization_endpoint: 'https://www.mollie.com/oauth2/authorize',
-        token_endpoint:         'https://api.mollie.nl/oauth2/tokens'
-    )
-
-    client.authorization_code = params['code']
-    client.access_token!.access_token
-  end
-end

data/examples/apis/customers.rb

@@ -1,116 +0,0 @@
-class Application < Sinatra::Application
-  swagger_schema :CustomerRequest do
-    property :name, type: :string, description: 'Name', example: "John doe"
-    property :email, type: :string, description: 'Email', example: "john@example.com"
-    property :locale, type: :string, description: 'locale', example: "en_US"
-    property :metadata, type: :object, description: 'Metadata', example: { "user_id" => "12345" }
-    property :profileId, type: :object, description: 'ProfileId (Connect api only)', example: "pfl_FxPFwdxxJf"
-    property :testmode, type: :boolean, description: '(Connect api only)', example: true
-  end
-
-  swagger_path '/v1/customers' do
-    operation :get, description: 'https://www.mollie.com/en/docs/reference/customers/list', tags: ['Customers'] do
-      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
-      parameter name: :count, in: 'query', description: 'Count', type: :integer
-      parameter name: :testmode, in: 'query', type: :boolean, description: '(Connect api only)', example: true
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/v1/customers' do
-    operation :post, description: 'https://www.mollie.com/en/docs/reference/customers/create', tags: ['Customers'] do
-      security api_key: []
-      parameter name: :customer, in: 'body', description: 'CustomerRequest params', schema: { '$ref' => '#/definitions/CustomerRequest' }
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/v1/customers/{id}' do
-    operation :get, description: 'https://www.mollie.com/en/docs/reference/customers/get', tags: ['Customers'] do
-      parameter name: :id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
-      parameter name: :testmode, in: 'query', type: :boolean, description: '(Connect api only)', example: true
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-    operation :patch, description: 'https://www.mollie.com/en/docs/reference/customers/create', tags: ['Customers'] do
-      parameter name: :id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
-      security api_key: []
-      parameter name: :customer, in: 'body', description: 'CustomerRequest params', schema: { '$ref' => '#/definitions/CustomerRequest' }
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/v1/customers/{customer_id}/payments' do
-    operation :get, description: 'https://www.mollie.com/en/docs/reference/customers/list-payments', tags: ['Customers'] do
-      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
-      parameter name: :testmode, in: 'query', type: :boolean, description: '(Connect api only)', example: true
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-
-    operation :post, description: 'https://www.mollie.com/en/docs/reference/customers/create-payment', tags: ['Customers'] do
-      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: 'cst_GUvJFqwVCD'
-      parameter name: :payment, in: 'body', description: 'PaymentRequest params', schema: { '$ref' => '#/definitions/PaymentRequest' }
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  get '/v1/customers' do
-    customers = Mollie::Customer.all(params[:offset], params[:count], testmode: params[:testmode])
-    JSON.pretty_generate(customers.attributes)
-  end
-
-  get '/v1/customers/:id' do
-    customer = Mollie::Customer.get(params[:id], testmode: params[:testmode])
-    JSON.pretty_generate(customer.attributes)
-  end
-
-  post '/v1/customers' do
-    customer = Mollie::Customer.create(
-      name:      json_params['name'],
-      email:     json_params['email'],
-      locale:    json_params['locale'],
-      metadata:  json_params['metadata'],
-      profileId: json_params['profileId'],
-      testmode:  json_params['testmode']
-    )
-    JSON.pretty_generate(customer.attributes)
-  end
-
-  patch '/v1/customers/:id' do
-    customer = Mollie::Customer.update(params[:id],
-                                       name:     json_params['name'],
-                                       email:    json_params['email'],
-                                       locale:   json_params['locale'],
-                                       metadata: json_params['metadata'],
-    )
-    JSON.pretty_generate(customer.attributes)
-  end
-
-  get '/v1/customers/:customer_id/payments' do
-    payments = Mollie::Customer::Payment.all(customer_id: params[:customer_id], testmode: params[:testmode])
-    JSON.pretty_generate(payments.attributes)
-  end
-
-  post '/v1/customers/:customer_id/payments' do
-    payment = Mollie::Customer::Payment.create(
-      customer_id:  params[:customer_id],
-      amount:       json_params['amount'],
-      description:  json_params['description'],
-      redirect_url: json_params['redirect_url'],
-      webhook_url:  json_params['webhook_url'],
-      metadata:     json_params['metadata'],
-      profileId:    json_params['profileId'],
-      testmode:     json_params['testmode']
-    )
-    JSON.pretty_generate(payment.attributes)
-  end
-end

data/examples/apis/invoices.rb

@@ -1,38 +0,0 @@
-class Application < Sinatra::Application
-  swagger_path '/v1/invoices' do
-    operation :get, description: 'List invoices https://www.mollie.com/en/docs/reference/invoices/list', tags: ['Invoices'] do
-      parameter name: :include, in: 'query', description: 'Include', type: :string, example: "lines,settlements"
-      parameter name: :reference, in: 'query', description: 'Issuer id', type: :string, example: "inv_FrvewDA3Pr"
-      parameter name: :year, in: 'query', description: 'Issuer id', type: :integer, example: Time.now.year
-      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
-      parameter name: :count, in: 'query', description: 'Count', type: :integer
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/v1/invoices/{id}' do
-    operation :get, description: 'Get invoice', tags: ['Invoices'] do
-      parameter name: :id, in: 'path', description: 'Issuer id', type: :string, example: "inv_FrvewDA3Pr"
-      parameter name: :include, in: 'query', description: 'Includes', type: :string, example: "lines,settlements"
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  get '/v1/invoices' do
-    invoices = Mollie::Invoice.all(params[:offset], params[:count],
-                                   include:   params[:include],
-                                   reference: params[:reference],
-                                   year:      params[:year]
-    )
-    JSON.pretty_generate(invoices.attributes)
-  end
-
-  get '/v1/invoices/:id' do
-    invoice = Mollie::Invoice.get(params[:id], include: params[:include])
-    JSON.pretty_generate(invoice.attributes)
-  end
-end

data/examples/apis/issuers.rb

@@ -1,35 +0,0 @@
-class Application < Sinatra::Application
-  swagger_path '/v1/issuers' do
-    operation :get, description: 'List issuers https://www.mollie.com/en/docs/reference/issuers/list', tags: ['Issuers'] do
-      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
-      parameter name: :count, in: 'query', description: 'Count', type: :integer
-      parameter name: :testmode, in: 'query', description: 'Test mode', type: :boolean
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/v1/issuers/{id}' do
-    operation :get, description: 'Get issuer', tags: ['Issuers'] do
-      parameter name: :id, in: 'path', description: 'Issuer id', type: :string
-      parameter name: :testmode, in: 'query', description: 'Test mode', type: :boolean
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  get '/v1/issuers' do
-    issuers = Mollie::Issuer.all(params[:offset], params[:count],
-                                 testmode: params[:testmode])
-    JSON.pretty_generate(issuers.attributes)
-  end
-
-  get '/v1/issuers/:id' do
-    issuer = Mollie::Issuer.get(params[:id],
-                                testmode: params[:testmode]
-    )
-    JSON.pretty_generate(issuer.attributes)
-  end
-end

data/examples/apis/mandates.rb

@@ -1,83 +0,0 @@
-class Application < Sinatra::Application
-  swagger_schema :MandateRequest do
-    property :method, type: :decimal, description: 'Method', example: "directdebit"
-    property :consumer_name, type: :string, description: 'Consumer name', example: "Customer A"
-    property :consumer_account, type: :string, description: 'Account number', example: "NL17RABO0213698412"
-    property :consumer_bic, type: :string, description: 'BIC', example: "RABONL2U"
-    property :signature_date, type: :string, description: 'Date mandate was signed', example: "2016-05-01"
-    property :mandate_reference, type: :string, description: 'A custom reference', example: "YOUR-COMPANY-MD13804"
-    property :webhook_url, type: :string, description: 'URL for redirection', example: "https://webshop.example.org/payments/webhook/"
-    property :testmode, type: :boolean, description: '(Connect api only)', example: true
-  end
-
-  swagger_path '/v1/customers/{customer_id}/mandates' do
-    operation :post, description: 'Create mandates', tags: ['Mandates'] do
-      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
-      security api_key: []
-      parameter name: :mandate, in: 'body', description: 'MandateRequest params', schema: { '$ref' => '#/definitions/MandateRequest' }
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-
-    operation :get, description: 'List mandates', tags: ['Mandates'] do
-      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
-      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
-      parameter name: :count, in: 'query', description: 'Count', type: :integer
-      parameter name: :testmode, in: 'query', description: 'Testmode', type: :boolean, default: true
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/v1/customers/{customer_id}/mandates/{id}' do
-    operation :get, description: 'Get mandate', tags: ['Mandates'] do
-      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
-      parameter name: :id, in: 'path', description: 'Mandate id', type: :string, default: "mdt_qP7Qk6mgaz"
-      parameter name: :testmode, in: 'query', description: 'Testmode', type: :boolean, default: true
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-
-    operation :delete, description: 'Remove mandate', tags: ['Mandates'] do
-      parameter name: :customer_id, in: 'path', description: 'Customer id', type: :string, default: "cst_GUvJFqwVCD"
-      parameter name: :id, in: 'path', description: 'Mandate id', type: :string, default: "mdt_qP7Qk6mgaz"
-      parameter name: :testmode, in: 'query', description: 'Testmode', type: :boolean, default: true
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  post '/v1/customers/:customer_id/mandates' do
-    mandate = Mollie::Customer::Mandate.create(
-      customer_id:       params[:customer_id],
-      method:            json_params['method'],
-      consumer_name:     json_params['consumer_name'],
-      consumer_account:  json_params['consumer_account'],
-      consumer_bic:      json_params['consumer_bic'],
-      signature_date:    json_params['signature_date'],
-      mandate_reference: json_params['mandate_reference'],
-      webhook_url:       json_params['webhook_url'],
-      testmode:          json_params['testmode']
-    )
-    JSON.pretty_generate(mandate.attributes)
-  end
-
-  get '/v1/customers/:customer_id/mandates' do
-    mandates = Mollie::Customer::Mandate.all(params[:offset], params[:count], testmode: params[:testmode], customer_id: params[:customer_id])
-    JSON.pretty_generate(mandates.attributes)
-  end
-
-
-  get '/v1/customers/:customer_id/mandates/:id' do
-    mandate = Mollie::Customer::Mandate.get(params[:id], testmode: params[:testmode], customer_id: params[:customer_id])
-    JSON.pretty_generate(mandate.attributes)
-  end
-
-  delete '/v1/customers/:customer_id/mandates/:id' do
-    Mollie::Customer::Mandate.delete(params[:id], testmode: params[:testmode], customer_id: params[:customer_id])
-    "deleted"
-  end
-end

data/examples/apis/methods.rb

@@ -1,50 +0,0 @@
-class Application < Sinatra::Application
-  swagger_path '/v1/methods' do
-    operation :get, description: 'List methods https://www.mollie.com/en/docs/reference/methods/list', tags: ['Methods'] do
-      parameter name: :include, in: 'query', description: 'Include additional data, e.g. issuers', type: :string
-      parameter name: :recurring_type, in: 'query', description: 'Recurring type', type: :string, default: 'first'
-      parameter name: :locale, in: 'query', description: 'Locale', type: :integer
-      parameter name: :offset, in: 'query', description: 'Offset', type: :integer
-      parameter name: :count, in: 'query', description: 'Count', type: :integer
-      parameter name: :profile_id, in: 'query', description: 'Profile ID', type: :string
-      parameter name: :testmode, in: 'query', description: 'Test mode', type: :boolean
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  swagger_path '/v1/methods/{id}' do
-    operation :get, description: 'Get method', tags: ['Methods'] do
-      parameter name: :id, in: 'path', description: 'Method id', type: :string
-      parameter name: :include, in: 'query', description: 'Include additional data, e.g. issuers', type: :string
-      parameter name: :locale, in: 'query', description: 'Locale', type: :integer
-      parameter name: :profile_id, in: 'query', description: 'Profile ID', type: :string
-      parameter name: :testmode, in: 'query', description: 'Test mode', type: :boolean
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  get '/v1/methods' do
-    methods = Mollie::Method.all(params[:offset], params[:count],
-                                 include:        params[:include],
-                                 recurring_type: params[:recurring_type],
-                                 locale:         params[:locale],
-                                 profile_id:     params[:profile_id],
-                                 testmode:       params[:testmode]
-    )
-    JSON.pretty_generate(methods.attributes)
-  end
-
-  get '/v1/methods/:id' do
-    method = Mollie::Method.get(params[:id],
-                                include:    params[:include],
-                                locale:     params[:locale],
-                                profile_id: params[:profile_id],
-                                testmode:   params[:testmode]
-    )
-    JSON.pretty_generate(method.attributes)
-  end
-end

data/examples/apis/organizations.rb

@@ -1,16 +0,0 @@
-class Application < Sinatra::Application
-  swagger_path '/v1/organizations/{id}' do
-    operation :get, description: 'Get organization https://www.mollie.com/en/docs/reference/organizations/get', tags: ['Organizations'] do
-      parameter name: :id, in: 'path', description: 'Organization id', type: :string
-      parameter name: :testmode, in: 'query', description: 'Test mode', type: :boolean
-      security api_key: []
-      response 200, description: 'Successful response'
-      response 500, description: 'Unexpected error'
-    end
-  end
-
-  get '/v1/organizations/:id' do
-    organization = Mollie::Organization.get(params[:id], testmode: params[:testmode])
-    JSON.pretty_generate(organization.attributes)
-  end
-end